Modifier un modèle d’organisation

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/organization-templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "admin_roles_assignment": [
    "<string>"
  ],
  "allowed_strategies": [],
  "connection_profile_id": "<string>",
  "enforce_permission_ceiling": true,
  "enforce_self_assignment_restriction": true,
  "invitation_landing_client_id": "<string>",
  "is_default": true,
  "name": "<string>",
  "role_visibility_policy": {
    "overrides": [
      {
        "role_id": "<string>"
      }
    ]
  },
  "use_for_organization_discovery": {
    "default_value": true,
    "allowed_values": [
      true
    ]
  },
  "user_attribute_profile_id": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/organization-templates/{id}"

payload = {
    "admin_roles_assignment": ["<string>"],
    "allowed_strategies": [],
    "connection_profile_id": "<string>",
    "enforce_permission_ceiling": True,
    "enforce_self_assignment_restriction": True,
    "invitation_landing_client_id": "<string>",
    "is_default": True,
    "name": "<string>",
    "role_visibility_policy": { "overrides": [{ "role_id": "<string>" }] },
    "use_for_organization_discovery": {
        "default_value": True,
        "allowed_values": [True]
    },
    "user_attribute_profile_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    admin_roles_assignment: ['<string>'],
    allowed_strategies: [],
    connection_profile_id: '<string>',
    enforce_permission_ceiling: true,
    enforce_self_assignment_restriction: true,
    invitation_landing_client_id: '<string>',
    is_default: true,
    name: '<string>',
    role_visibility_policy: {overrides: [{role_id: '<string>'}]},
    use_for_organization_discovery: {default_value: true, allowed_values: [true]},
    user_attribute_profile_id: '<string>'
  })
};

fetch('https://{tenantDomain}/api/v2/organization-templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organization-templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'admin_roles_assignment' => [
        '<string>'
    ],
    'allowed_strategies' => [
        
    ],
    'connection_profile_id' => '<string>',
    'enforce_permission_ceiling' => true,
    'enforce_self_assignment_restriction' => true,
    'invitation_landing_client_id' => '<string>',
    'is_default' => true,
    'name' => '<string>',
    'role_visibility_policy' => [
        'overrides' => [
                [
                                'role_id' => '<string>'
                ]
        ]
    ],
    'use_for_organization_discovery' => [
        'default_value' => true,
        'allowed_values' => [
                true
        ]
    ],
    'user_attribute_profile_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/organization-templates/{id}"

	payload := strings.NewReader("{\n  \"admin_roles_assignment\": [\n    \"<string>\"\n  ],\n  \"allowed_strategies\": [],\n  \"connection_profile_id\": \"<string>\",\n  \"enforce_permission_ceiling\": true,\n  \"enforce_self_assignment_restriction\": true,\n  \"invitation_landing_client_id\": \"<string>\",\n  \"is_default\": true,\n  \"name\": \"<string>\",\n  \"role_visibility_policy\": {\n    \"overrides\": [\n      {\n        \"role_id\": \"<string>\"\n      }\n    ]\n  },\n  \"use_for_organization_discovery\": {\n    \"default_value\": true,\n    \"allowed_values\": [\n      true\n    ]\n  },\n  \"user_attribute_profile_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/organization-templates/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"admin_roles_assignment\": [\n    \"<string>\"\n  ],\n  \"allowed_strategies\": [],\n  \"connection_profile_id\": \"<string>\",\n  \"enforce_permission_ceiling\": true,\n  \"enforce_self_assignment_restriction\": true,\n  \"invitation_landing_client_id\": \"<string>\",\n  \"is_default\": true,\n  \"name\": \"<string>\",\n  \"role_visibility_policy\": {\n    \"overrides\": [\n      {\n        \"role_id\": \"<string>\"\n      }\n    ]\n  },\n  \"use_for_organization_discovery\": {\n    \"default_value\": true,\n    \"allowed_values\": [\n      true\n    ]\n  },\n  \"user_attribute_profile_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organization-templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"admin_roles_assignment\": [\n    \"<string>\"\n  ],\n  \"allowed_strategies\": [],\n  \"connection_profile_id\": \"<string>\",\n  \"enforce_permission_ceiling\": true,\n  \"enforce_self_assignment_restriction\": true,\n  \"invitation_landing_client_id\": \"<string>\",\n  \"is_default\": true,\n  \"name\": \"<string>\",\n  \"role_visibility_policy\": {\n    \"overrides\": [\n      {\n        \"role_id\": \"<string>\"\n      }\n    ]\n  },\n  \"use_for_organization_discovery\": {\n    \"default_value\": true,\n    \"allowed_values\": [\n      true\n    ]\n  },\n  \"user_attribute_profile_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "admin_roles_assignment": [
    "<string>"
  ],
  "allowed_strategies": [
    "adfs"
  ],
  "connection_deletion_behavior": "allow",
  "connection_profile_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "enforce_permission_ceiling": true,
  "enforce_self_assignment_restriction": true,
  "id": "<string>",
  "invitation_landing_client_id": "<string>",
  "is_default": true,
  "name": "<string>",
  "organization_deletion_behavior": "allow",
  "role_visibility_policy": {
    "default_value": "write",
    "overrides": [
      {
        "access": "write",
        "role_id": "<string>"
      }
    ]
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "use_for_organization_discovery": {
    "default_value": true,
    "allowed_values": [
      true
    ]
  },
  "user_attribute_profile_id": "<string>"
}

{
  "error": "Bad Request",
  "message": "<string>",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "<string>",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "<string>",
  "statusCode": 403
}

{
  "error": "Not Found",
  "message": "<string>",
  "statusCode": 404
}

{
  "error": "Too Many Requests",
  "message": "<string>",
  "statusCode": 429
}

PATCH

https://{tenantDomain}/api/v2

organization-templates

{id}

Modifier un modèle d’organisation

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/organization-templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "admin_roles_assignment": [
    "<string>"
  ],
  "allowed_strategies": [],
  "connection_profile_id": "<string>",
  "enforce_permission_ceiling": true,
  "enforce_self_assignment_restriction": true,
  "invitation_landing_client_id": "<string>",
  "is_default": true,
  "name": "<string>",
  "role_visibility_policy": {
    "overrides": [
      {
        "role_id": "<string>"
      }
    ]
  },
  "use_for_organization_discovery": {
    "default_value": true,
    "allowed_values": [
      true
    ]
  },
  "user_attribute_profile_id": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/organization-templates/{id}"

payload = {
    "admin_roles_assignment": ["<string>"],
    "allowed_strategies": [],
    "connection_profile_id": "<string>",
    "enforce_permission_ceiling": True,
    "enforce_self_assignment_restriction": True,
    "invitation_landing_client_id": "<string>",
    "is_default": True,
    "name": "<string>",
    "role_visibility_policy": { "overrides": [{ "role_id": "<string>" }] },
    "use_for_organization_discovery": {
        "default_value": True,
        "allowed_values": [True]
    },
    "user_attribute_profile_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    admin_roles_assignment: ['<string>'],
    allowed_strategies: [],
    connection_profile_id: '<string>',
    enforce_permission_ceiling: true,
    enforce_self_assignment_restriction: true,
    invitation_landing_client_id: '<string>',
    is_default: true,
    name: '<string>',
    role_visibility_policy: {overrides: [{role_id: '<string>'}]},
    use_for_organization_discovery: {default_value: true, allowed_values: [true]},
    user_attribute_profile_id: '<string>'
  })
};

fetch('https://{tenantDomain}/api/v2/organization-templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organization-templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'admin_roles_assignment' => [
        '<string>'
    ],
    'allowed_strategies' => [
        
    ],
    'connection_profile_id' => '<string>',
    'enforce_permission_ceiling' => true,
    'enforce_self_assignment_restriction' => true,
    'invitation_landing_client_id' => '<string>',
    'is_default' => true,
    'name' => '<string>',
    'role_visibility_policy' => [
        'overrides' => [
                [
                                'role_id' => '<string>'
                ]
        ]
    ],
    'use_for_organization_discovery' => [
        'default_value' => true,
        'allowed_values' => [
                true
        ]
    ],
    'user_attribute_profile_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/organization-templates/{id}"

	payload := strings.NewReader("{\n  \"admin_roles_assignment\": [\n    \"<string>\"\n  ],\n  \"allowed_strategies\": [],\n  \"connection_profile_id\": \"<string>\",\n  \"enforce_permission_ceiling\": true,\n  \"enforce_self_assignment_restriction\": true,\n  \"invitation_landing_client_id\": \"<string>\",\n  \"is_default\": true,\n  \"name\": \"<string>\",\n  \"role_visibility_policy\": {\n    \"overrides\": [\n      {\n        \"role_id\": \"<string>\"\n      }\n    ]\n  },\n  \"use_for_organization_discovery\": {\n    \"default_value\": true,\n    \"allowed_values\": [\n      true\n    ]\n  },\n  \"user_attribute_profile_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/organization-templates/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"admin_roles_assignment\": [\n    \"<string>\"\n  ],\n  \"allowed_strategies\": [],\n  \"connection_profile_id\": \"<string>\",\n  \"enforce_permission_ceiling\": true,\n  \"enforce_self_assignment_restriction\": true,\n  \"invitation_landing_client_id\": \"<string>\",\n  \"is_default\": true,\n  \"name\": \"<string>\",\n  \"role_visibility_policy\": {\n    \"overrides\": [\n      {\n        \"role_id\": \"<string>\"\n      }\n    ]\n  },\n  \"use_for_organization_discovery\": {\n    \"default_value\": true,\n    \"allowed_values\": [\n      true\n    ]\n  },\n  \"user_attribute_profile_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organization-templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"admin_roles_assignment\": [\n    \"<string>\"\n  ],\n  \"allowed_strategies\": [],\n  \"connection_profile_id\": \"<string>\",\n  \"enforce_permission_ceiling\": true,\n  \"enforce_self_assignment_restriction\": true,\n  \"invitation_landing_client_id\": \"<string>\",\n  \"is_default\": true,\n  \"name\": \"<string>\",\n  \"role_visibility_policy\": {\n    \"overrides\": [\n      {\n        \"role_id\": \"<string>\"\n      }\n    ]\n  },\n  \"use_for_organization_discovery\": {\n    \"default_value\": true,\n    \"allowed_values\": [\n      true\n    ]\n  },\n  \"user_attribute_profile_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "admin_roles_assignment": [
    "<string>"
  ],
  "allowed_strategies": [
    "adfs"
  ],
  "connection_deletion_behavior": "allow",
  "connection_profile_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "enforce_permission_ceiling": true,
  "enforce_self_assignment_restriction": true,
  "id": "<string>",
  "invitation_landing_client_id": "<string>",
  "is_default": true,
  "name": "<string>",
  "organization_deletion_behavior": "allow",
  "role_visibility_policy": {
    "default_value": "write",
    "overrides": [
      {
        "access": "write",
        "role_id": "<string>"
      }
    ]
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "use_for_organization_discovery": {
    "default_value": true,
    "allowed_values": [
      true
    ]
  },
  "user_attribute_profile_id": "<string>"
}

{
  "error": "Bad Request",
  "message": "<string>",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "<string>",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "<string>",
  "statusCode": 403
}

{
  "error": "Not Found",
  "message": "<string>",
  "statusCode": 404
}

{
  "error": "Too Many Requests",
  "message": "<string>",
  "statusCode": 429
}

Autorisations

Authorization

string

header

requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

string<organization-template-id>

requis

Identifiant du modèle d’organisation.

Corps

admin_roles_assignment

string<role-id>[] | null

Rôles d’administrateur par défaut à attribuer aux créateurs d’organisations.

Maximum array length: 10

Identifiant du rôle.

allowed_strategies

enum<string>[] | null

Liste des stratégies de connexion autorisées pour ce modèle.

Une stratégie de connexion d’entreprise autorisée.

Options disponibles:

adfs,

google-apps,

oidc,

okta,

pingfederate,

samlp,

waad

connection_deletion_behavior

enum<string>

Détermine si les connexions créées à partir de ce modèle peuvent être supprimées.

Options disponibles:

allow,

allow_if_empty

connection_profile_id

string<connection-profile-id> | null

Le profil de connexion à appliquer aux nouvelles connexions.

enforce_permission_ceiling

boolean

Indique s’il faut imposer le plafond d’autorisations aux organisations utilisant ce modèle.

enforce_self_assignment_restriction

boolean

Indique s’il faut imposer les restrictions d’auto-attribution aux organisations utilisant ce modèle.

invitation_landing_client_id

string<client-id> | null

L’ID client de la page de destination des invitations.

is_default

boolean

Indique si ce modèle est celui appliqué par défaut aux nouvelles organisations.

name

string

Le nom du modèle d’organisation.

Required string length: 1 - 100

Pattern: ^[^\x00]*$

organization_deletion_behavior

enum<string>

Détermine si les organisations utilisant ce modèle peuvent être supprimées.

Options disponibles:

allow,

allow_if_empty

role_visibility_policy

object | null

Contrôle la visibilité des rôles pour les administrateurs de l’organisation.

Show child attributes

use_for_organization_discovery

object | null

Détermine si les connexions de ce modèle sont utilisées pour la découverte d’organisations.

Show child attributes

user_attribute_profile_id

string<user-attribute-profile-id> | null

Le profil d’attributs utilisateur à appliquer aux organisations.

Réponse

Modèle d’organisation mis à jour avec succès.

admin_roles_assignment

string<role-id>[]

Rôles d’administrateur par défaut à attribuer aux créateurs d’organisations.

Identifiant du rôle.

allowed_strategies

enum<string>[]

Liste des stratégies de connexion autorisées pour ce modèle.

Une stratégie de connexion d’entreprise autorisée.

Options disponibles:

adfs,

google-apps,

oidc,

okta,

pingfederate,

samlp,

waad

connection_deletion_behavior

enum<string>

Détermine si les connexions créées à partir de ce modèle peuvent être supprimées.

Options disponibles:

allow,

allow_if_empty

connection_profile_id

string<connection-profile-id>

Le profil de connexion à appliquer aux nouvelles connexions.

created_at

string<date-time>

L’horodatage au format ISO 8601 indiquant la date de création du modèle.

enforce_permission_ceiling

boolean

Indique s’il faut imposer le plafond d’autorisations aux organisations utilisant ce modèle.

enforce_self_assignment_restriction

boolean

Indique s’il faut imposer les restrictions d’auto-attribution aux organisations utilisant ce modèle.

string<organization-template-id>

Identifiant du modèle d’organisation.

invitation_landing_client_id

string<client-id>

L’ID client de la page de destination des invitations.

is_default

boolean

Indique s’il s’agit du modèle par défaut appliqué aux nouvelles organisations.

name

string

Nom du modèle d’organisation.

Required string length: 1 - 100

Pattern: ^[^\x00]*$

organization_deletion_behavior

enum<string>

Détermine si les organisations utilisant ce modèle peuvent être supprimées.

Options disponibles:

allow,

allow_if_empty

role_visibility_policy

object | null

Contrôle la visibilité des rôles pour les administrateurs de l’organisation.

Show child attributes

updated_at

string<date-time>

L’horodatage au format ISO 8601 indiquant la date de dernière mise à jour du modèle.

use_for_organization_discovery

object | null

Détermine si les connexions de ce modèle sont utilisées pour la découverte d’organisations.

Show child attributes

user_attribute_profile_id

string<user-attribute-profile-id>

Le profil d’attributs utilisateur à appliquer aux organisations.