ApiManagementTenants
POST
/v1/mgmt/tenant/update/batch

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

tenants?array<UpdateTenantRequest>

Update multiple tenants in a single batch, using a valid management key. Each tenant is updated independently; per-tenant failures are returned in the response body.

curl -X POST "https://api.descope.com/v1/mgmt/tenant/update/batch" \  -H "Content-Type: application/json" \  -d '{}'
{  "updatedTenantIds": [    "string"  ],  "failedTenants": [    {      "failure": "string",      "tenant": {        "id": "string",        "name": "string",        "selfProvisioningDomains": [          "string"        ],        "customAttributes": {          "attribute-key": "attribute-value"        },        "authType": "string",        "disabled": true,        "enforceSSO": true,        "enforceSSOExclusions": [          "string"        ],        "federatedAppIds": [          "string"        ],        "roleInheritance": "string"      }    }  ],  "additionalErrors": {    "property1": "string",    "property2": "string"  }}
export interface Response {updatedTenantIds?: string[]failedTenants?: UpdateTenantBatchFailureResponse[]additionalErrors?: {[k: string]: string}}export interface UpdateTenantBatchFailureResponse {failure?: stringtenant?: {id?: stringname?: stringselfProvisioningDomains?: string[]/** * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. */customAttributes?: {[k: string]: string}/** * deprecated - authType should be set via ConfigureTenantSettings */authType?: stringdisabled?: booleanenforceSSO?: booleanenforceSSOExclusions?: string[]federatedAppIds?: string[]roleInheritance?: string}}
Was this helpful?