---
canonical_url: "https://docs.composio.dev/toolkits/descope"
markdown_url: "https://docs.composio.dev/toolkits/descope.md"
product: "platform"
version: null
last_updated: null
---

# Descope

Manage Descope projects, users, tenants, authorization, authentication settings, audit data, and other administrative resources.

- **Category:** security & identity tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 449
- **Triggers:** 0
- **Slug:** `DESCOPE`
- **Version:** 00000000_00

## Tools

### Activate Access Key

**Slug:** `DESCOPE_ACTIVATE_ACCESS_KEY`

Activate Access Key. ### Activate an existing access key, using a valid management key. This API endpoint allows administrators to activate an existing access key. ### Next Steps Once you have reactivated the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Activate Access Keys

**Slug:** `DESCOPE_ACTIVATE_ACCESS_KEYS`

Batch Activate Access Keys. ### Activate existing access keys in batch, using a valid management key. This API endpoint allows administrators to activate existing access keys in batch. ### Next Steps Once you have reactivated the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Activate SCIM Access Keys

**Slug:** `DESCOPE_ACTIVATE_SCIMACCESS_KEYS`

Activate SCIM Access Keys. Re-enable specific deactivated SCIM access keys of a tenant, using a valid management key. This reverses a revoke that used revokeMode DEACTIVATE; keys that were deleted cannot be restored. The keys to activate must be named explicitly - call Load SCIM Access Keys to get their ids - so that a key deactivated because its secret leaked is never restored as a side effect.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | The SSO configuration the keys belong to. Omit it to target the tenant's default configuration - it does NOT mean "every configuration". |
| `key_ids` | array | Yes | The keys to activate, from LoadSCIMAccessKeys. Required and explicit on purpose: activating a whole configuration would silently restore a key an operator had deactivated because its secret leaked. Ids that are not SCIM keys of this tenant and configuration are rejected. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add IPs to List

**Slug:** `DESCOPE_ADD_IPS_TO_LIST`

Add IPs to List. Add one or more IPs to an existing IP list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `ips` | array | Yes | Descope field ips. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a named SSO application secret

**Slug:** `DESCOPE_ADD_SSOAPPLICATION_SECRET`

Add a named SSO application secret. Add a new named OIDC client secret to an SSO application, using a valid management key. Returns the new secret metadata and its cleartext value (shown only once).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `app_id` | string | Yes | Descope field appId. |
| `expire_time` | integer | No | Descope field expireTime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Texts to List

**Slug:** `DESCOPE_ADD_TEXTS_TO_LIST`

Add Texts to List. Add one or more text items to an existing text list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `texts` | array | Yes | Descope field texts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a named third party application secret

**Slug:** `DESCOPE_ADD_THIRD_PARTY_APPLICATION_SECRET`

Add a named third party application secret. Add a new named client secret to a third party application, using a valid management key. Returns the new secret metadata and its cleartext value (shown only once).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `expire_time` | integer | No | Descope field expireTime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Anonymous User

**Slug:** `DESCOPE_ANONYMOUS`

Anonymous User. ### Anonymous User Anonymous Users are identified with a unique Descope JWT type. Eventually, create a token that we can use as the defined anonymous identity. Signed by Descope. For more info, please refer to our anonymous users documentation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | No | Descope field roles. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `selected_tenant` | string | No | Descope field selectedTenant. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Apply JWT Template From Library

**Slug:** `DESCOPE_APPLY_JWT_TEMPLATE_FROM_LIBRARY`

Apply JWT Template From Library. Materialise a library entry as a new project JWT template. Optional overrides let the caller pick a different name, swap tags, or amend the claim body before save. Strict validation runs as if it were a create.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name_override` | string | No | Optional overrides applied on top of the library entry before save. |
| `tags_override` | array | No | Descope field tagsOverride. |
| `library_entry_id` | string | Yes | Descope field libraryEntryId. |
| `template_override` | object | No | Descope field templateOverride. |
| `description_override` | string | No | Descope field descriptionOverride. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AuthZEN Action Search

**Slug:** `DESCOPE_AUTH_ZEN_ACTION_SEARCH`

AuthZEN Action Search. Return the actions the subject may perform on the given resource (OpenID AuthZEN Action Search API).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context` | object | No | Descope field context. |
| `subject` | object | Yes | Descope field subject. |
| `resource` | object | Yes | Descope field resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AuthZEN Access Evaluation

**Slug:** `DESCOPE_AUTH_ZEN_EVALUATION`

AuthZEN Access Evaluation. Evaluate a single OpenID AuthZEN Access Evaluation request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | object | Yes | Descope field action. |
| `context` | object | No | Optional flat key-value context map for evaluating ABAC conditions |
| `subject` | object | Yes | Descope field subject. |
| `resource` | object | Yes | Descope field resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AuthZEN Access Evaluations

**Slug:** `DESCOPE_AUTH_ZEN_EVALUATIONS`

AuthZEN Access Evaluations. Evaluate a batch of OpenID AuthZEN Access Evaluation requests, with optional default values and combining semantics (execute_all, deny_on_first_deny, permit_on_first_permit).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | object | No | Descope field action. |
| `context` | object | No | Descope field context. |
| `options` | object | No | Options controlling how a batch of evaluations is executed (spec §7.1.2). |
| `subject` | object | No | Top-level default subject/resource/action/context applied to each evaluation when omitted there. |
| `resource` | object | No | Descope field resource. |
| `evaluations` | array | No | Descope field evaluations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AuthZEN Resource Search

**Slug:** `DESCOPE_AUTH_ZEN_RESOURCE_SEARCH`

AuthZEN Resource Search. Return the resources of the given type the subject may access with the given action (OpenID AuthZEN Resource Search API).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | object | Yes | Descope field action. |
| `context` | object | No | Descope field context. |
| `subject` | object | Yes | Descope field subject. |
| `resource` | object | Yes | Required (spec §8.5.1): MUST carry a type (selects the namespace, echoed onto each result); the id is omitted/ignored. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### AuthZEN Subject Search

**Slug:** `DESCOPE_AUTH_ZEN_SUBJECT_SEARCH`

AuthZEN Subject Search. Return the subjects permitted to perform the given action on the given resource (OpenID AuthZEN Subject Search API).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | object | Yes | Descope field action. |
| `context` | object | No | Descope field context. |
| `subject` | object | Yes | Required (spec §8.4.1): MUST carry a type (echoed onto each result); the id is omitted/ignored. |
| `resource` | object | Yes | Descope field resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Upload Outbound App Tenant OAuth Tokens

**Slug:** `DESCOPE_BATCH_UPLOAD_OUTBOUND_APP_TENANT_OAUTH_TOKENS`

Batch Upload Outbound App Tenant OAuth Tokens. ### Batch upload tenant OAuth tokens for an outbound application Import pre-existing tenant-scoped OAuth tokens in a single request. This operation is all-or-nothing: if any token fails validation, the entire batch is rejected and no tokens are committed. Fix the reported failures and retry the full batch. Requires a management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tokens` | array | Yes | Descope field tokens. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Upload Outbound App User OAuth Tokens

**Slug:** `DESCOPE_BATCH_UPLOAD_OUTBOUND_APP_USER_OAUTH_TOKENS`

Batch Upload Outbound App User OAuth Tokens. ### Batch upload user OAuth tokens for an outbound application Import pre-existing user-scoped OAuth tokens in a single request. This operation is all-or-nothing: if any token fails validation, the entire batch is rejected and no tokens are committed. Fix the reported failures and retry the full batch. Requires a management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tokens` | array | Yes | Descope field tokens. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check FGA Permission

**Slug:** `DESCOPE_CHECK`

Check FGA Permission. ### Check FGA permission This endpoint allows you to check if a target has a specific relation to a resource using Fine-Grained Authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tuples` | array | No | Deprecated: prefer checkTuples; kept for backwards compatibility. |
| `context` | object | No | Optional flat key-value context map for evaluating ABAC conditions; applies to all tuples unless a checkTuples entry carries its own context. |
| `check_tuples` | array | No | Optional per-tuple-context variant. Set either tuples or checkTuples (not both); each checkTuple's context overrides the request-level context above. |
| `compute_paths` | boolean | No | Descope field computePaths. |
| `list_conditions` | boolean | No | When true, include per-tuple evaluated conditions and their results in the response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check IP in List

**Slug:** `DESCOPE_CHECK_IPIN_LIST`

Check IP in List. Check if a specific IP exists in a list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `ip` | string | Yes | Descope field ip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Text in List

**Slug:** `DESCOPE_CHECK_TEXT_IN_LIST`

Check Text in List. Check if a text exists in a list. Send `texts` to check several texts in one request: `exists` is true if any of them is in the list, or only if all of them are when `matchAll` is true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `text` | string | No | Descope field text. |
| `texts` | array | No | Descope field texts. |
| `match_all` | boolean | No | When true, exists is true only if every text is in the list, otherwise if any is |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clear List

**Slug:** `DESCOPE_CLEAR_LIST`

Clear List. Clear all IPs from a list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Project

**Slug:** `DESCOPE_CLONE_PROJECT`

Clone Project. ### Clone a project utilizing a management key. This endpoint allows you to clone the current project, including its settings and configurations. _Note: This requires a pro or enterprise tier licenses. Users, tenants and access keys are not cloned._ ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `tags` | array | No | Descope field tags. |
| `environment` | string | No | Descope field environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Project (Async)

**Slug:** `DESCOPE_CLONE_PROJECT_ASYNC`

Clone Project (Async). Clone a project, including its settings and configurations. Users, tenants and access keys are not cloned. This API is asynchronous and will return a unique ID that can be used to track the progress of the clone operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `tags` | array | No | Descope field tags. |
| `environment` | string | No | Descope field environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete External Authentication

**Slug:** `DESCOPE_COMPLETE_EXTERNAL_AUTH_FLOW`

Complete External Authentication. Complete an external authentication flow step. Called by the customer's backend after authenticating the user on their own page. Requires a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | No | Descope field user. |
| `login_id` | string | Yes | Descope field loginId. |
| `user_tenants` | array | No | Descope field userTenants. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `email_verified` | boolean | No | Descope field emailVerified. |
| `phone_verified` | boolean | No | Descope field phoneVerified. |
| `selected_tenant_id` | string | No | Descope field selectedTenantId. |
| `external_auth_req_id` | string | Yes | Descope field externalAuthReqId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tenant Password Settings

**Slug:** `DESCOPE_CONFIGURE_PASSWORD_SETTINGS`

Update Tenant Password Settings. ### Update password settings for a tenant This endpoint allows you to update the password settings of a given tenant. ### See Also - See [tenant password settings](/customize/tenant#passwords) for details about tenant password settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lock` | boolean | No | Descope field lock. |
| `reuse` | boolean | No | Descope field reuse. |
| `number` | boolean | No | Descope field number. |
| `enabled` | boolean | No | Descope field enabled. |
| `lowercase` | boolean | No | Descope field lowercase. |
| `temp_lock` | boolean | No | Descope field tempLock. |
| `tenant_id` | string | No | Descope field tenantId. |
| `uppercase` | boolean | No | Descope field uppercase. |
| `any_letter` | boolean | No | Descope field anyLetter. |
| `expiration` | boolean | No | Descope field expiration. |
| `min_length` | integer | Yes | Descope field minLength. |
| `reuse_amount` | integer | Yes | Descope field reuseAmount. |
| `lock_attempts` | integer | Yes | Descope field lockAttempts. |
| `expiration_weeks` | integer | Yes | Descope field expirationWeeks. |
| `non_alphanumeric` | boolean | No | Descope field nonAlphanumeric. |
| `temp_lock_attempts` | integer | No | Descope field tempLockAttempts. |
| `temp_lock_duration` | integer | No | Descope field tempLockDuration. |
| `disallow_email_match` | boolean | No | Descope field disallowEmailMatch. |
| `disallowed_characters` | string | No | Descope field disallowedCharacters. |
| `password_strength_score` | integer | No | Descope field passwordStrengthScore. |
| `enable_password_strength` | boolean | No | Descope field enablePasswordStrength. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable or disable an SSO configuration

**Slug:** `DESCOPE_CONFIGURE_SSOAUTH_TYPE`

Enable or disable an SSO configuration. Set the authentication type of a tenant SSO configuration, using a valid management key. Setting it to none disables the configuration without deleting it, and setting it back to saml or oidc re-enables it with its stored settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `auth_type` | string | Yes | Descope field authType. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Tenant's OIDC Settings

**Slug:** `DESCOPE_CONFIGURE_SSOOIDCSETTINGS`

Set Tenant's OIDC Settings. ### Configure the OIDC settings of a tenant, using a valid management key. This API endpoint will configure the OIDC settings on a tenant utilizing a valid management key. This endpoint accepts the OIDC configuration settings as well as the attribute mapping you would like to be configured on the SAML settings. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `domains` | array | No | Descope field domains. |
| `settings` | object | Yes | Descope field settings. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Configure SSO Redirect URL

**Slug:** `DESCOPE_CONFIGURE_SSOREDIRECT_URL`

Configure SSO Redirect URL. Configure tenant SSO Redirect URL, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `saml_redirect_url` | string | No | Descope field samlRedirectUrl. |
| `oauth_redirect_url` | string | No | Descope field oauthRedirectUrl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Tenant's SAML Settings

**Slug:** `DESCOPE_CONFIGURE_SSOSAMLSETTINGS`

Set Tenant's SAML Settings. ### Configure the SAML Settings, using a valid management key. This API endpoint will configure the SAML settings on a tenant utilizing a valid management key. This API endpoint accepts idpURL, entityId, idpCert, and redirectURL which will be applied to the tenant under SSO Configuration section and will select the option to "Enter the connection details manually" This endpoint also accepts the attribute mapping you would like to be configured on the SAML settings. These configurations will need to be captured directly from your idp provider. The values for each field can be obtained from the admin console of the identity provider. Alternatively, administrators can configure SAML without applying these setting manually via [Configure SAML Metadata URL](/api/management/tenants/sso/configure-sso-saml-settings-by-metadata) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `domains` | array | No | Descope field domains. |
| `settings` | object | Yes | Descope field settings. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `redirect_url` | string | No | Descope field redirectUrl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Tenant's SAML Settings via Metadata URL

**Slug:** `DESCOPE_CONFIGURE_SSOSAMLSETTINGS_BY_METADATA`

Set Tenant's SAML Settings via Metadata URL. ### Configure the SAML Metadata URL, using a valid management key. This API endpoint will configure the SAML Metadata URL on a tenant utilizing a valid management key. This API endpoint accepts idpMetadataURL which will be applied to the tenant under SSO Configuration section and will select the option to "Retrieve the connection details dynamically using a metadata URL" This endpoint also accepts the attribute mapping you would like to be configured on the SAML settings. This Metadata URL can can be obtained from the admin console of the identity provider. Configuring SAML via Metadata URL allows administrators to configure SAML without applying these setting manually via [Configure SAML Settings](/api/management/tenants/sso/configure-sso-saml-settings) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `domains` | array | No | Descope field domains. |
| `settings` | object | Yes | Descope field settings. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `redirect_url` | string | No | Descope field redirectUrl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tenant Session Settings

**Slug:** `DESCOPE_CONFIGURE_TENANT_SETTINGS`

Update Tenant Session Settings. ### Update session settings for a tenant This endpoint allows you to update the session settings of a given tenant. ### See Also - See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domains` | array | No | Descope field domains. |
| `enabled` | boolean | No | Descope field enabled. |
| `auth_type` | string | No | Descope field authType. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `jitdisabled` | boolean | No | Descope field JITDisabled. |
| `inactivity_time` | integer | No | Descope field inactivityTime. |
| `enable_inactivity` | boolean | No | Descope field enableInactivity. |
| `inactivity_time_unit` | string | No | Descope field inactivityTimeUnit. |
| `stepup_token_expiration` | integer | No | Descope field stepupTokenExpiration. |
| `refresh_token_expiration` | integer | No | Descope field refreshTokenExpiration. |
| `session_token_expiration` | integer | No | Descope field sessionTokenExpiration. |
| `sso_setup_suite_settings` | object | No | Descope field ssoSetupSuiteSettings. |
| `self_provisioning_domains` | array | No | Descope field selfProvisioningDomains. |
| `stepup_token_expiration_unit` | string | No | Descope field stepupTokenExpirationUnit. |
| `refresh_token_expiration_unit` | string | No | Descope field refreshTokenExpirationUnit. |
| `session_token_expiration_unit` | string | No | Descope field sessionTokenExpirationUnit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Access Key

**Slug:** `DESCOPE_CREATE_ACCESS_KEY`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Create Access Key. ### Create an access key, using a valid management key. This API endpoint allows administrators to create an access key. During the creation of the access key, you can set the name, expiration time, roles and tenant:role pairs to associated with the key. ### Next Steps Once you have the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `user_id` | string | No | Descope field userId. |
| `role_names` | array | No | Descope field roleNames. |
| `description` | string | No | Descope field description. |
| `expire_time` | string | No | Descope field expireTime. |
| `key_tenants` | array | No | Descope field keyTenants. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `permitted_ips` | array | No | Descope field permittedIps. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Audit Event

**Slug:** `DESCOPE_CREATE_AUDIT_EVENT`

Create Audit Event. ### Create an audit log event, using a valid management key. This API endpoint allows you to create an audit log utilizing various parameters and returns the results in JSON format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Descope field data. |
| `type` | string | Yes | Descope field type. |
| `action` | string | Yes | Descope field action. |
| `user_id` | string | No | Descope field userId. |
| `actor_id` | string | Yes | Descope field actorId. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create auth access policy rule

**Slug:** `DESCOPE_CREATE_AUTH_ACCESS_RULE`

Create auth access policy rule. Create a project-level auth access policy rule. The rule is appended at the end of the evaluation order, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Server-generated, rejected on create and required on update. |
| `name` | string | No | Descope field name. |
| `effect` | string | No | Required on create. Evaluation is first-match. |
| `enabled` | boolean | No | Defaults to true on create. |
| `conditions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `description` | string | No | Descope field description. |
| `expire_time` | integer | No | Epoch seconds after which the rule is no longer evaluated. 0 means never. |
| `created_time` | integer | No | int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md. |
| `modified_time` | integer | No | Descope field modifiedTime. |
| `evaluation_order` | integer | No | 1-based position in the evaluation order, set through the reorder and settings endpoints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create connector

**Slug:** `DESCOPE_CREATE_CONNECTOR`

Create connector. Create a connector from a template, using a valid management key. `type` is the template id from LoadAllConnectorTemplates, and `configuration` holds the template's fields by name as GetConnectorTemplate describes them. The server checks the configuration against the template before saving it: required fields must be set, values must match their field's type, allowed options and dependencies, unknown fields are rejected, and missing fields with a default are filled in. Returns the stored connector, with secret values as `PLACEHOLDER_VALUE` and defaults filled in. Messaging provider types such as `sendgrid`, except `smtp`, are stored as messaging providers with ids starting with `MP` and are not checked, since they have no template. A connector does nothing by itself; the template's `types` says how it is used: a `flows` connector is called from a flow by the `connector` action with the connector's id (agents on the Descope MCP find it with GetActionCatalog, query `con

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | The connector id, assigned by the server on create and required on update. |
| `name` | string | Yes | The connector's display name. |
| `type` | string | Yes | The connector template id, such as `http`, which cannot change after create. LoadAllConnectorTemplates lists the available templates. |
| `status` | string | No | Either `enabled` or `disabled`, defaults to `enabled` on create. A disabled connector is not run by flows or automatic triggers; audit streaming ignores `status` and follows the template's `auditEnabled` configuration field if it has one, and is otherwise always on. While its secrets are placeholders, create a connector `disabled`, also set `auditEnabled: false` on an audit connector whose template has that field, and enable it once the real values are in. |
| `description` | string | No | A free text description of the connector. |
| `configuration` | object | No | The template's configuration fields by name, as GetConnectorTemplate describes them. Checked against the template on create and update, with missing defaults filled in; not checked for messaging providers, which have no template. Secret values are returned as `PLACEHOLDER_VALUE`, and sending that value back keeps the stored secret. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Descoper

**Slug:** `DESCOPE_CREATE_DESCOPERS`

Create Descoper. Create a descoper

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `descopers` | array | Yes | Descope field descopers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create dynamic registration template

**Slug:** `DESCOPE_CREATE_DYNAMIC_REGISTRATION_TEMPLATE`

Create dynamic registration template. Create a new dynamic registration template, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `tags` | array | No | Descope field tags. |
| `description` | string | No | Descope field description. |
| `login_page_url` | string | No | Descope field loginPageURL. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `skip_consent_screen` | boolean | No | Descope field skipConsentScreen. |
| `fallback_client_logo` | string | No | Descope field fallbackClientLogo. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create engine

**Slug:** `DESCOPE_CREATE_ENGINE`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Create engine. Create a new engine, returning its ID and secret. Requires a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Family

**Slug:** `DESCOPE_CREATE_FAMILY`

Create Family. Create a family, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `photo` | string | No | Descope field photo. |
| `disabled` | boolean | No | Descope field disabled. |
| `family_id` | string | No | familyId - optional caller-supplied family ID; a random one is generated when omitted. Not validated as descope_id since a caller-supplied ID need not match Descope's own generated-ID format. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Family Custom Attribute

**Slug:** `DESCOPE_CREATE_FAMILY_CUSTOM_ATTRIBUTE`

Create Family Custom Attribute. Create one or more custom attribute definitions on the family entity, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attributes` | array | No | Descope field attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Family Dependent

**Slug:** `DESCOPE_CREATE_FAMILY_DEPENDENT`

Create Family Dependent. Create a dependent (shadow profile) user in a family

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `email` | string | No | Descope field email. |
| `phone` | string | No | Descope field phone. |
| `picture` | string | No | Descope field picture. |
| `login_id` | string | No | when the login ID is missing it is derived from the name; email/phone are never used as the login ID (they are not unique - a dependent may share them with their guardian) |
| `family_id` | string | Yes | the family to create the dependent in |
| `given_name` | string | No | Descope field givenName. |
| `family_name` | string | No | Descope field familyName. |
| `middle_name` | string | No | Descope field middleName. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `family_scoped_attributes` | object | No | Descope field familyScopedAttributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create FGA Backup

**Slug:** `DESCOPE_CREATE_FGABACKUP`

Create FGA Backup. Create a new FGA backup.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create FGA Relations

**Slug:** `DESCOPE_CREATE_FGARELATIONS`

Create Fine-Grained Authorization relation tuples. This mutates the FGA relationship graph; use GET_FGARELATIONS to retrieve existing relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tuples` | array | No | Descope field tuples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save FGA Schema

**Slug:** `DESCOPE_CREATE_FGASCHEMA`

Save FGA Schema. ### Save FGA schema This endpoint allows you to save (create or update) the Fine-Grained Authorization schema for your project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dsl` | string | Yes | Descope field dsl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create governance access request

**Slug:** `DESCOPE_CREATE_GOVERNANCE_ACCESS_REQUEST`

Create governance access request. Create an Agentic Governance Suite access request to provision an agent client on behalf of a developer, using a valid management key. The requestorUserId is required and must be an existing, active console user in your company; the requestor name is taken from that user's record (display name, else email, else the user id), and any requestorName sent is ignored. When auto-approval is on and the current policies already permit the request, it is approved and the client provisioned immediately. Requires the Agentic Governance Suite in the company license, and fails while the suite is disabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scopes` | array | No | Descope field scopes. |
| `targets` | array | No | The resources and connections the client asks to reach. |
| `client_name` | string | No | The name for the agent client. |
| `client_type` | string | No | The type of agent client requested. |
| `grant_types` | array | No | The OAuth grant types requested: authCode, clientCredentials, jwtBearer or ciba. |
| `justification` | string | No | The requester's reason for the request. |
| `requestor_user_id` | string | Yes | The console user the request is raised for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create JWT Template

**Slug:** `DESCOPE_CREATE_JWT_TEMPLATE`

Create JWT Template. Create a new JWT template. Strict validation runs first — if it fails, the response carries a list of `ValidationIssue`s with stable codes (RESERVED_CLAIM_KEY, NAME_MISSING, …) and the template is not saved. type must be "user" or "key". authSchema in {default,tenantOnly,none}. issuerType in {legacy,inbound,federated}. emptyClaimPolicy in {none,nil,delete}. The `template` field is the JSON object whose keys are claim names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | object | Yes | Descope field template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `DESCOPE_CREATE_LIST`

Create List. Create a new list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `name` | string | Yes | Descope field name. |
| `type` | string | No | Descope field type. |
| `description` | string | No | Descope field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Management Key

**Slug:** `DESCOPE_CREATE_MANAGEMENT_KEY`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Create Management Key. Create a management key using another management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `re_bac` | object | Yes | Only one kind of roles is granted: company roles, otherwise project roles, otherwise tag roles. Every role is granted on every listed project or tag, up to 20000 grants in total. |
| `expires_in` | string | No | Descope field expiresIn. |
| `description` | string | No | Descope field description. |
| `expire_time` | string | No | Descope field expireTime. |
| `permitted_ips` | array | No | Descope field permittedIps. |
| `trusted_issuer` | object | No | Descope field trustedIssuer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create MCP Server Client

**Slug:** `DESCOPE_CREATE_MCP_SERVER_CLIENT`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Create MCP Server Client. Create an MCP Server Client, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `tags` | array | No | Descope field tags. |
| `scopes` | array | No | Descope field scopes. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create template

**Slug:** `DESCOPE_CREATE_MESSAGING_TEMPLATE`

Create template. Create a message template for an auth method and delivery channel, using a valid management key. The created template is returned with its server-generated id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `body` | string | No | Descope field body. |
| `name` | string | Yes | Descope field name. |
| `type` | string | Yes | Descope field type. |
| `method` | string | Yes | Descope field method. |
| `subject` | string | No | The fields below apply to email templates only: requests that carry them for other template types are rejected, and responses omit them. Like the fields above they're written as given on updates, so an omitted field is cleared rather than preserved. |
| `body_plain_text` | string | No | Descope field bodyPlainText. |
| `use_body_plain_text` | boolean | No | Descope field useBodyPlainText. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Outbound App

**Slug:** `DESCOPE_CREATE_OUTBOUND_APP`

Create Outbound App. ### Create outbound application This endpoint allows you to create a new outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `pkce` | boolean | No | Descope field pkce. |
| `prompt` | array | No | Descope field prompt. |
| `dcr_url` | string | No | Descope field dcrUrl. |
| `use_dcr` | boolean | No | Descope field useDcr. |
| `app_type` | string | No | Descope field appType. |
| `client_id` | string | No | string templateId = 4 [(validate).string = {std_len: true , optional: true}]; - will always be custom |
| `tenant_id` | string | No | Descope field tenantId. |
| `token_url` | string | No | Descope field tokenUrl. |
| `use_nonce` | boolean | No | Send a nonce on the authorization request and require the token response to carry an id_token with the same nonce. |
| `access_type` | string | No | Descope field accessType. |
| `description` | string | No | Descope field description. |
| `client_secret` | string | No | Descope field clientSecret. |
| `discovery_url` | string | No | Descope field discoveryUrl. |
| `default_scopes` | array | No | Descope field defaultScopes. |
| `revocation_url` | string | No | Descope field revocationUrl. |
| `callback_domain` | string | No | Descope field callbackDomain. |
| `token_url_params` | array | No | Descope field tokenUrlParams. |
| `authorization_url` | string | No | Descope field authorizationUrl. |
| `default_redirect_url` | string | No | Descope field defaultRedirectUrl. |
| `authorization_url_params` | array | No | Descope field authorizationUrlParams. |
| `token_endpoint_auth_method` | string | No | Token endpoint client authentication method. Empty or "client_secret" sends clientSecret as the client secret; "private_key_jwt" signs an RFC 7523 client assertion with the project signing key published in the project JWKS. |
| `token_endpoint_auth_signing_alg` | string | No | Client assertion signing algorithm used with private_key_jwt. Empty means RS256. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create outbound application according to existing dcr preset

**Slug:** `DESCOPE_CREATE_OUTBOUND_APP_BY_DCR_PRESET`

Create outbound application according to existing dcr preset. Create a new outbound application according to existing dcr preset, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | No | Descope field tenantId. |
| `dcr_preset_id` | string | Yes | Descope field dcrPresetId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create outbound application by existing template

**Slug:** `DESCOPE_CREATE_OUTBOUND_APP_BY_TEMPLATE`

Create outbound application by existing template. Create a new outbound application by existing template using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `client_id` | string | No | Descope field clientId. |
| `overrides` | object | No | Descope field overrides. |
| `tenant_id` | string | No | Descope field tenantId. |
| `template_id` | string | Yes | Descope template ID used by this operation. |
| `client_secret` | string | No | Descope field clientSecret. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create outbound SCIM configuration

**Slug:** `DESCOPE_CREATE_OUTBOUND_SCIMCONFIGURATION`

Create outbound SCIM configuration. Create a new outbound SCIM configuration, using a valid management key. Configures a SCIM connector that provisions users from a federated application to an external SCIM 2.0 service provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `configuration` | object | Yes | Descope field configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Permission

**Slug:** `DESCOPE_CREATE_PERMISSION`

Create Permission. ### Create a permission, using a valid management key. This API endpoint allows administrators to create a new permission. The endpoint takes the following two parameters: - name (required) - description (optional) ### Next Steps Once you have this data, you can utilize the newly created role to [Create Roles](/api/management/roles/create-role) or [Update Roles](/api/management/roles/update-role) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `description` | string | No | Descope field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Create Permissions

**Slug:** `DESCOPE_CREATE_PERMISSIONS`

Bulk Create Permissions. Bulk create Permissions, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `permissions` | array | No | Descope field permissions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create policy rule

**Slug:** `DESCOPE_CREATE_POLICY_RULE`

Create policy rule. Create a new policy rule row using a valid management key. The id is server-generated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policy_rule` | object | No | Descope field policyRule. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `DESCOPE_CREATE_PROJECT`

Create Project. Create a new project in the management key's company, using a valid company-level management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `tags` | array | No | Descope field tags. |
| `environment` | string | No | Descope field environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a list of authz relations

**Slug:** `DESCOPE_CREATE_RELATIONS`

Create a list of authz relations. Create a list of authz relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `relations` | array | No | Descope field relations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create resource

**Slug:** `DESCOPE_CREATE_RESOURCE`

Create resource. Create a new resource, using a valid management key. A resource is a backend API (type api, the default) or an MCP server (type mcp) that clients get tokens for. The uri is required and must be unique in the project, and the type and uri cannot be changed later. Each scopes.connectionsScopes entry maps a scope that clients request (its name) onto connection (Outbound App) scopes, with values in the form outboundAppId:scope, or outboundAppId:* for every scope of an API key connection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uri` | string | Yes | Resource URI, used as the access token audience. For an MCP server, this is the MCP server URL and is required. |
| `name` | string | Yes | Descope field name. |
| `type` | string ("api" | "mcp") | No | The kind of Resource. Use `api` for an API Resource that protects a backend you build, or `mcp` for an MCP Server Resource that serves tools over the Model Context Protocol. Set it on every create request. `dynamicRegistrationSettings` applies only when `type` is `mcp`. |
| `scopes` | object | No | Descope field scopes. |
| `description` | string | No | Descope field description. |
| `user_access` | string | No | User access to the resource: allow, deny or allowViaPolicy. |
| `client_access` | string | No | Client access to the resource: allow, deny or allowViaPolicy. |
| `id_jag_target` | object | No | IdJagTargetSettings configures the ID-JAG (Cross App Access) assertion an inbound app receives when it exchanges a token for this api-typed Resource: an external server (typically a remote MCP server) protected by another authorization server. The values describe the TARGET system that will accept the assertion, not this project. Not allowed on mcp-typed Resources, which this project protects itself. |
| `dynamic_registration_settings` | object | No | Client registration settings (DCR, CIMD, login page and client defaults). Used by MCP servers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Role

**Slug:** `DESCOPE_CREATE_ROLE`

Create one project-level or tenant-scoped role with an optional permission set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique role name. |
| `default` | boolean | No | Whether this is a default role. |
| `private` | boolean | No | Whether this is a private role. |
| `tenant_id` | string | No | Tenant ID for a tenant-scoped role; omit for a project role. |
| `description` | string | No | Human-readable explanation of what the role allows. |
| `permission_names` | array | No | Permission names granted by the role; omit for no permissions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Create Roles

**Slug:** `DESCOPE_CREATE_ROLES`

Bulk Create Roles. Bulk create Roles, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | No | Descope field roles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SCIM Access Key

**Slug:** `DESCOPE_CREATE_SCIMACCESS_KEY`

Create SCIM Access Key. Create a SCIM access key for a tenant, using a valid management key. The key is scoped to the given tenant and carries the roles and custom claims SCIM requires, so the returned bearer token can be pasted straight into an identity provider's SCIM configuration. Existing SCIM keys for the same SSO configuration stay valid. The cleartext is returned exactly once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Defaults to a name derived from the tenant and SSO configuration. |
| `sso_id` | string | No | The SSO configuration this key provisions into. Omit it to target the tenant's default configuration - it does NOT mean "every configuration". |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `description` | string | No | Descope field description. |
| `expire_time` | string | No | Epoch seconds. 0, the default, means the key never expires. An expired SCIM key stops the identity provider from provisioning, so prefer 0 unless you have a rotation process. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SSO application custom attribute definitions

**Slug:** `DESCOPE_CREATE_SSOAPPLICATION_CUSTOM_ATTRIBUTE`

Create SSO application custom attribute definitions. Create or update SSO application custom attribute definitions, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attributes` | array | No | Descope field attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SSO application permission

**Slug:** `DESCOPE_CREATE_SSOAPPLICATION_PERMISSION`

Create SSO application permission. Create a permission scoped to an SSO application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `app_id` | string | Yes | Descope field appId. |
| `description` | string | No | Descope field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SSO application role

**Slug:** `DESCOPE_CREATE_SSOAPPLICATION_ROLE`

Create SSO application role. Create a role scoped to an SSO application, using a valid management key. Role permissionIds must reference permissions of the same application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `app_id` | string | Yes | Descope field appId. |
| `description` | string | No | Descope field description. |
| `role_mappings` | array | No | Descope field roleMappings. |
| `permission_ids` | array | No | Descope field permissionIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create OIDC Application

**Slug:** `DESCOPE_CREATE_SSOOIDCAPPLICATION`

Create OIDC Application. ### Create OIDC Application within a project This endpoint creates an OIDC Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `claims` | array | No | Descope field claims. |
| `enabled` | boolean | No | Descope field enabled. |
| `client_id` | string | No | Optional: import an existing OIDC client. Both are accepted on create only (immutable afterward); empty means the client_id is computed and the client_secret is generated server-side. The client_id must be unique within the project. The client_secret is returned once on the create response. |
| `dark_logo` | string | No | Descope field darkLogo. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | How the app authenticates as an OAuth client. 'confidential': a dedicated client ID and client secret, for server-side apps. 'public': a dedicated client ID and PKCE with no secret, for native, mobile and single-page apps. These apps normally use the project-level issuer and discovery endpoints. On create, an empty clientType means the legacy Access Key type (the project ID is the client ID, and the issuer and discovery endpoints are per app); accounts that can't use the legacy type get 'confidential' instead. On update, an empty clientType keeps the app's current type. |
| `description` | string | No | Descope field description. |
| `client_secret` | string | No | Descope field clientSecret. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `trusted_app_ids` | array | No | trustedAppIds lists sibling SSO apps whose roles are included in this app's JWT under the `trustedApps` claim at login time. Apps where the user has no roles are silently omitted. |
| `default_audience` | string | No | Default audience policy for issued tokens. Applies only to modern apps (non-empty clientType): 'projectId', 'clientId', 'appId', empty (both), or 'empty' (no aud at all). Legacy apps are unaffected. Mirrors third-party apps. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `assigned_role_ids` | array | No | assignedRoleIds lists project-level roles that grant access to this application. A user holding any of them can access it, in addition to users assigned directly or through their tenant. Additive: it never removes access, so it only changes the outcome for projects that deny applications by default. Tenant scoped roles are rejected. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `jwt_bearer_disabled` | boolean | No | Descope field jwtBearerDisabled. |
| `jwt_bearer_settings` | object | No | Descope field jwtBearerSettings. |
| `device_code_disabled` | boolean | No | Descope field deviceCodeDisabled. |
| `force_authentication` | boolean | No | Descope field forceAuthentication. |
| `service_account_roles` | array | No | serviceAccountRoles assigns this app (when client_credentials is enabled) application-roles in its trusted apps; surfaced in its client_credentials token under the `app.trustedApps` claim. |
| `trusted_apps_audience` | string | No | Audience policy applied to trusted sibling apps' identifiers when appended to the issued token's `aud` (see trustedAppIds). Same value set as defaultAudience: 'projectId' / 'clientId' / 'appId' / empty (=both) / 'empty' (add none). Independent of defaultAudience. |
| `approved_redirect_urls` | array | No | Descope field approvedRedirectUrls. |
| `refresh_token_disabled` | boolean | No | Descope field refreshTokenDisabled. |
| `back_channel_logout_url` | string | No | Descope field backChannelLogoutUrl. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `well_known_customization` | object | No | Descope field wellKnownCustomization. |
| `authorization_code_disabled` | boolean | No | Descope field authorizationCodeDisabled. |
| `client_credentials_disabled` | boolean | No | Descope field clientCredentialsDisabled. |
| `custom_idp_initiated_login_page_url` | string | No | Descope field customIdpInitiatedLoginPageUrl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SAML Application

**Slug:** `DESCOPE_CREATE_SSOSAMLAPPLICATION`

Create SAML Application. ### Create SAML Application within a project This endpoint creates a SAML Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `acs_url` | string | No | Descope field acsUrl. |
| `enabled` | boolean | No | Descope field enabled. |
| `dark_logo` | string | No | Descope field darkLogo. |
| `entity_id` | string | No | Descope field entityId. |
| `certificate` | string | No | Descope field certificate. |
| `description` | string | No | Descope field description. |
| `metadata_url` | string | No | Descope field metadataUrl. |
| `groups_mapping` | array | No | Descope field groupsMapping. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `assigned_role_ids` | array | No | assignedRoleIds lists project-level roles that grant access to this application. A user holding any of them can access it, in addition to users assigned directly or through their tenant. Additive: it never removes access, so it only changes the outcome for projects that deny applications by default. Tenant scoped roles are rejected. |
| `attribute_mapping` | array | No | Descope field attributeMapping. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `use_metadata_info` | boolean | No | Descope field useMetadataInfo. |
| `error_redirect_url` | string | No | Descope field errorRedirectUrl. |
| `default_relay_state` | string | No | Descope field defaultRelayState. |
| `logout_redirect_url` | string | No | Descope field logoutRedirectUrl. |
| `force_authentication` | boolean | No | Descope field forceAuthentication. |
| `subject_name_id_type` | string | No | Descope field subjectNameIdType. |
| `acs_allowed_callbacks` | array | No | Descope field acsAllowedCallbacks. |
| `subject_name_id_format` | string | No | Descope field subjectNameIdFormat. |
| `default_signature_algorithm` | string | No | Descope field defaultSignatureAlgorithm. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SSO WS-Fed IDP application

**Slug:** `DESCOPE_CREATE_SSOWSFED_APPLICATION`

Create SSO WS-Fed IDP application. Create a new SSO WS-Fed IDP application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `realm` | string | No | Descope field realm. |
| `enabled` | boolean | No | Descope field enabled. |
| `dark_logo` | string | No | Descope field darkLogo. |
| `reply_url` | string | No | Descope field replyUrl. |
| `description` | string | No | Descope field description. |
| `groups_mapping` | array | No | Descope field groupsMapping. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `assigned_role_ids` | array | No | assignedRoleIds lists project-level roles that grant access to this application. A user holding any of them can access it, in addition to users assigned directly or through their tenant. Additive: it never removes access, so it only changes the outcome for projects that deny applications by default. Tenant scoped roles are rejected. |
| `attribute_mapping` | array | No | Descope field attributeMapping. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `error_redirect_url` | string | No | Descope field errorRedirectUrl. |
| `logout_redirect_url` | string | No | Descope field logoutRedirectUrl. |
| `force_authentication` | boolean | No | Descope field forceAuthentication. |
| `reply_allowed_callbacks` | array | No | Descope field replyAllowedCallbacks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tenant

**Slug:** `DESCOPE_CREATE_TENANT`

Create one tenant in the connected Descope project without sending authentication messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique name for the new tenant. |
| `disabled` | boolean | No | Whether login to the new tenant is disabled. |
| `auth_type` | string | No | Authentication type for the tenant. |
| `tenant_id` | string | No | Unique tenant ID. Omit to let Descope generate one. |
| `enforce_sso` | boolean | No | Whether the new tenant requires SSO login. |
| `approved_domains` | array | No | Tenant vanity hostnames. Descope currently supports one item. |
| `parent_tenant_id` | string | No | Parent tenant ID when creating a subtenant. |
| `role_inheritance` | string ("" | "none" | "userOnly") | No | Role inheritance behavior: an empty string, none, or userOnly. Omit for Descope's default. |
| `custom_attributes` | object | No | Values for tenant custom attributes already configured in the Descope project. |
| `federated_app_ids` | array | No | Federated application IDs assigned to the tenant. |
| `enforce_sso_exclusions` | array | No | User IDs exempt from SSO enforcement. |
| `self_provisioning_domains` | array | No | Domains whose authenticating users should join this tenant. |
| `enforce_sso_exclusion_permissions` | array | No | Permission names or IDs allowed to bypass enforced SSO for break-glass access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create tenant auth access policy rule

**Slug:** `DESCOPE_CREATE_TENANT_AUTH_ACCESS_RULE`

Create tenant auth access policy rule. Create a tenant-level auth access policy rule. The rule is appended at the end of the tenant evaluation order, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Server-generated, rejected on create and required on update. |
| `name` | string | No | Descope field name. |
| `effect` | string | No | Required on create. Evaluation is first-match. |
| `enabled` | boolean | No | Defaults to true on create. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |
| `conditions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `description` | string | No | Descope field description. |
| `expire_time` | integer | No | Epoch seconds after which the rule is no longer evaluated. 0 means never. |
| `created_time` | integer | No | int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md. |
| `modified_time` | integer | No | Descope field modifiedTime. |
| `evaluation_order` | integer | No | 1-based position in the evaluation order, set through the reorder and settings endpoints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tenants Batch

**Slug:** `DESCOPE_CREATE_TENANTS_BATCH`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenants` | array | Yes | Descope field tenants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Test User

**Slug:** `DESCOPE_CREATE_TEST_USER`

Create Test User. Create a test user, using a valid management key. Configured user custom attribute defaults are applied to omitted keys on new users; explicitly supplied values take precedence. Existing users are not changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `test` | boolean | No | Descope field test. |
| `email` | string | No | Descope field email. |
| `phone` | string | No | Descope field phone. |
| `invite` | boolean | No | Descope field invite. |
| `locale` | string | No | Descope field locale. |
| `status` | string | No | Descope field status. |
| `picture` | string | No | Descope field picture. |
| `login_id` | string | Yes | Descope field loginId. |
| `password` | string | No | Descope field password. |
| `send_sms` | boolean | No | Descope field sendSMS. |
| `send_mail` | boolean | No | Descope field sendMail. |
| `given_name` | string | No | Descope field givenName. |
| `invite_url` | string | No | Descope field inviteUrl. |
| `role_names` | array | No | Descope field roleNames. |
| `family_name` | string | No | Descope field familyName. |
| `middle_name` | string | No | Descope field middleName. |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |
| `user_tenants` | array | No | Descope field userTenants. |
| `recovery_email` | string | No | Descope field recoveryEmail. |
| `recovery_phone` | string | No | Descope field recoveryPhone. |
| `verified_email` | boolean | No | Descope field verifiedEmail. |
| `verified_phone` | boolean | No | Descope field verifiedPhone. |
| `hashed_password` | object | No | Descope field hashedPassword. |
| `template_options` | object | No | Descope field templateOptions. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `family_associations` | array | No | each AssociatedFamily carries its own roleNames and familyScopedAttributes |
| `additional_identifiers` | array | No | Descope field additionalIdentifiers. |
| `verified_recovery_email` | boolean | No | Descope field verifiedRecoveryEmail. |
| `verified_recovery_phone` | boolean | No | Descope field verifiedRecoveryPhone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create third party application

**Slug:** `DESCOPE_CREATE_THIRD_PARTY_APPLICATION`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Create third party application. Create a new third party application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `logo_url` | string | No | Descope field logoUrl. |
| `client_id` | string | No | Descope field clientId. |
| `force_par` | boolean | No | Descope field forcePar. |
| `force_dpop` | boolean | No | Descope field forceDpop. |
| `force_mtls` | boolean | No | Descope field forceMtls. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | Descope field clientType. |
| `description` | string | No | Descope field description. |
| `ciba_enabled` | boolean | No | cibaEnabled allows the CIBA grant (urn:openid:params:grant-type:ciba) for this app and requires cibaSettings. Default false. A public client cannot use this grant. |
| `jar_settings` | object | No | JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications |
| `rar_settings` | object | No | Descope field rarSettings. |
| `ciba_settings` | object | No | Descope field cibaSettings. |
| `client_secret` | string | No | Descope field clientSecret. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `consent_flow_id` | string | No | Descope field consentFlowId. |
| `default_audience` | string | No | Descope field defaultAudience. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `attributes_scopes` | array | No | Descope field attributesScopes. |
| `client_assertions` | array | No | clientAssertions are the private_key_jwt trust entries (JWKS URL or PEM public key per entry). |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `audience_whitelist` | array | No | Descope field audienceWhitelist. |
| `client_auth_method` | string | No | clientAuthMethod: "clientSecret" (default when empty), "privateKeyJwt" (only clientAssertions are accepted), "workloadIdentity" (only workloadClientAssertions are accepted) or "mtls" (only a registered mTLS certificate is accepted). |
| `connections_scopes` | array | No | Descope field connectionsScopes. |
| `permissions_scopes` | array | No | Descope field permissionsScopes. |
| `jwt_bearer_disabled` | boolean | No | jwtBearerDisabled rejects the JWT bearer grant (urn:ietf:params:oauth:grant-type:jwt-bearer) for this app. Default false. A public client cannot use this grant. |
| `jwt_bearer_settings` | object | No | string backChannelLogoutUrl = 10 [(validate).string = {url: true, optional: true}]; |
| `scope_claim_mapping` | array | No | scopeClaimMapping is the structured scope→claim model. Consumed by CreateThirdPartyApplicationV2 (v2 write-replace: attributesScopes is ignored/cleared). v1 ignores this field. |
| `allow_partial_scopes` | boolean | No | Descope field allowPartialScopes. |
| `device_code_disabled` | boolean | No | deviceCodeDisabled rejects the device authorization grant (urn:ietf:params:oauth:grant-type:device_code) for this app. Default false. |
| `id_jag_target_clients` | object | No | Descope field idJagTargetClients. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `refresh_token_disabled` | boolean | No | refreshTokenDisabled rejects the refresh_token grant for this app, so its tokens cannot be refreshed. Default false. |
| `non_confidential_client` | boolean | No | Descope field nonConfidentialClient. |
| `token_exchange_disabled` | boolean | No | tokenExchangeDisabled rejects the token exchange grant (urn:ietf:params:oauth:grant-type:token-exchange) for this app. Default false. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `workload_client_assertions` | array | No | workloadClientAssertions are the workload identity trust entries (SPIFFE trust domain or OIDC issuer per entry). |
| `authorization_code_disabled` | boolean | No | authorizationCodeDisabled rejects the authorization_code grant for this app, including its authorization requests. Default false. |
| `client_credentials_disabled` | boolean | No | clientCredentialsDisabled rejects the client_credentials grant for this app. Default false. A public client cannot use this grant. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create third party application consent

**Slug:** `DESCOPE_CREATE_THIRD_PARTY_APPLICATION_CONSENT`

Create third party application consent. Create a user consent for a third party application, using a valid management key. Use it to migrate consents a user already granted elsewhere, so the user is not asked to consent again. The scopes are added to any existing consent of the user for the same application and tenant. The consent is validated like one granted on the consent screen: every scope must be defined by the application, the mandatory scopes of the application must be included (all of its scopes when it does not allow partial scopes), and the user must hold the roles and permissions the scopes map to. Consents of agentic applications cannot be created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | The third party application ID |
| `scopes` | array | No | The consented scopes, each defined by the application, including all of its mandatory scopes |
| `user_id` | string | Yes | The ID of the user who granted the consent |
| `tenant_id` | string | No | Optional tenant the consent is bound to. The user must be a member of this tenant |
| `expire_time` | integer | No | Optional expiration time of the consent, in seconds since the epoch. Zero means the consent never expires |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create third party application (v2)

**Slug:** `DESCOPE_CREATE_THIRD_PARTY_APPLICATION_V2`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Create third party application (v2). Create a new third party application using the structured scope-claim mapping model, using a valid management key. The legacy attributesScopes field is ignored.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `logo_url` | string | No | Descope field logoUrl. |
| `client_id` | string | No | Descope field clientId. |
| `force_par` | boolean | No | Descope field forcePar. |
| `force_dpop` | boolean | No | Descope field forceDpop. |
| `force_mtls` | boolean | No | Descope field forceMtls. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | Descope field clientType. |
| `description` | string | No | Descope field description. |
| `ciba_enabled` | boolean | No | cibaEnabled allows the CIBA grant (urn:openid:params:grant-type:ciba) for this app and requires cibaSettings. Default false. A public client cannot use this grant. |
| `jar_settings` | object | No | JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications |
| `rar_settings` | object | No | Descope field rarSettings. |
| `ciba_settings` | object | No | Descope field cibaSettings. |
| `client_secret` | string | No | Descope field clientSecret. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `consent_flow_id` | string | No | Descope field consentFlowId. |
| `default_audience` | string | No | Descope field defaultAudience. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `client_assertions` | array | No | clientAssertions are the private_key_jwt trust entries (JWKS URL or PEM public key per entry). |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `audience_whitelist` | array | No | Descope field audienceWhitelist. |
| `client_auth_method` | string | No | clientAuthMethod: "clientSecret" (default when empty), "privateKeyJwt" (only clientAssertions are accepted), "workloadIdentity" (only workloadClientAssertions are accepted) or "mtls" (only a registered mTLS certificate is accepted). |
| `connections_scopes` | array | No | Descope field connectionsScopes. |
| `permissions_scopes` | array | No | Descope field permissionsScopes. |
| `jwt_bearer_disabled` | boolean | No | jwtBearerDisabled rejects the JWT bearer grant (urn:ietf:params:oauth:grant-type:jwt-bearer) for this app. Default false. A public client cannot use this grant. |
| `jwt_bearer_settings` | object | No | Descope field jwtBearerSettings. |
| `scope_claim_mapping` | array | No | Descope field scopeClaimMapping. |
| `allow_partial_scopes` | boolean | No | Descope field allowPartialScopes. |
| `device_code_disabled` | boolean | No | deviceCodeDisabled rejects the device authorization grant (urn:ietf:params:oauth:grant-type:device_code) for this app. Default false. |
| `id_jag_target_clients` | object | No | Descope field idJagTargetClients. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `refresh_token_disabled` | boolean | No | refreshTokenDisabled rejects the refresh_token grant for this app, so its tokens cannot be refreshed. Default false. |
| `non_confidential_client` | boolean | No | Descope field nonConfidentialClient. |
| `token_exchange_disabled` | boolean | No | tokenExchangeDisabled rejects the token exchange grant (urn:ietf:params:oauth:grant-type:token-exchange) for this app. Default false. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `workload_client_assertions` | array | No | workloadClientAssertions are the workload identity trust entries (SPIFFE trust domain or OIDC issuer per entry). |
| `authorization_code_disabled` | boolean | No | authorizationCodeDisabled rejects the authorization_code grant for this app, including its authorization requests. Default false. |
| `client_credentials_disabled` | boolean | No | clientCredentialsDisabled rejects the client_credentials grant for this app. Default false. A public client cannot use this grant. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User

**Slug:** `DESCOPE_CREATE_USER`

Create User. ### Create a new user, using a valid management key. This API endpoint will create a new user utilizing a valid management key. This API endpoint allows you to configure all aspects of a user: - loginId - email - phone - verified settings (phone, email) - one must be set to true - displayName - roleNames - Tenant configurations - which tenantIds, which roleNames. The userTenants can include multiple items Ex: ``` "userTenants": [ { "tenantId": "T2IMjmRfYTQHlbaastz3im59ERS3", "roleNames": [ "Test" ] }, { "tenantId": "T2Igau6dX1R6SkomtFCdBLrc3r67", "roleNames": [ "Test" ] } ``` Additionally, you can create a user with multiple login IDs by passing an array of loginIds in string format within the `additionalIdentifiers` key. ### Next Steps Once the user is created, the user can then login utilizing any sign-in api supported. This will then switch the user from invited to active. ### See also - See [Manage User](/manage/users) for further details on managing users. - See [The

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `test` | boolean | No | Descope field test. |
| `email` | string | No | Descope field email. |
| `phone` | string | No | Descope field phone. |
| `invite` | boolean | No | Descope field invite. |
| `locale` | string | No | Descope field locale. |
| `status` | string | No | Descope field status. |
| `picture` | string | No | Descope field picture. |
| `login_id` | string | Yes | Descope field loginId. |
| `password` | string | No | Descope field password. |
| `send_sms` | boolean | No | Descope field sendSMS. |
| `send_mail` | boolean | No | Descope field sendMail. |
| `given_name` | string | No | Descope field givenName. |
| `invite_url` | string | No | Descope field inviteUrl. |
| `role_names` | array | No | Descope field roleNames. |
| `family_name` | string | No | Descope field familyName. |
| `middle_name` | string | No | Descope field middleName. |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |
| `user_tenants` | array | No | Descope field userTenants. |
| `recovery_email` | string | No | Descope field recoveryEmail. |
| `recovery_phone` | string | No | Descope field recoveryPhone. |
| `verified_email` | boolean | No | Descope field verifiedEmail. |
| `verified_phone` | boolean | No | Descope field verifiedPhone. |
| `hashed_password` | object | No | Descope field hashedPassword. |
| `template_options` | object | No | Descope field templateOptions. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `family_associations` | array | No | each AssociatedFamily carries its own roleNames and familyScopedAttributes |
| `additional_identifiers` | array | No | Descope field additionalIdentifiers. |
| `verified_recovery_email` | boolean | No | Descope field verifiedRecoveryEmail. |
| `verified_recovery_phone` | boolean | No | Descope field verifiedRecoveryPhone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Custom Attributes

**Slug:** `DESCOPE_CREATE_USER_CUSTOM_ATTRIBUTE`

Create a Custom Attributes. ### Create a custom attributes to configure on users within a project, using a valid management key. This API endpoint will create a custom attribute within a project. ### See also - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attributes` | array | No | Descope field attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Family-Scoped User Custom Attribute

**Slug:** `DESCOPE_CREATE_USER_FAMILY_SCOPED_CUSTOM_ATTRIBUTE`

Create Family-Scoped User Custom Attribute. Create one or more family-scoped user custom attribute definitions, using a valid management key. Values for these attributes are held per family membership rather than on the user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attributes` | array | No | Descope field attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Create Users

**Slug:** `DESCOPE_CREATE_USERS`

Batch Create Users. ### Batch Create Users, using a valid management key. This API endpoint will batch create new users utilizing a valid management key. This API endpoint allows you to configure all aspects of a user: - loginId - email - phone - verified settings (phone, email) - one must be set to true - displayName - roleNames - Tenant configurations - which tenantIds, which roleNames. The userTenants can include multiple items Ex: ``` "userTenants": [ { "tenantId": "T2IMjmRfYTQHlbaastz3im59ERS3", "roleNames": [ "Test" ] }, { "tenantId": "T2Igau6dX1R6SkomtFCdBLrc3r67", "roleNames": [ "Test" ] } ``` Additionally, you can create a user with multiple login IDs by passing an array of loginIds in string format within the `additionalIdentifiers` key. You can also decide whether to invite the users, configure the inviteUrl, and whether to send invites via email or SMS. When importing with hashed passwords, see [this guide](/migrate/custom#importing-passwords) for further detailed configura

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | No | Descope field users. |
| `invite` | boolean | No | Descope field invite. |
| `locale` | string | No | Descope field locale. |
| `send_sms` | boolean | No | Descope field sendSMS. |
| `send_mail` | boolean | No | Descope field sendMail. |
| `invite_url` | string | No | Descope field inviteUrl. |
| `template_options` | object | No | Descope field templateOptions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deactivate Access Key

**Slug:** `DESCOPE_DEACTIVATE_ACCESS_KEY`

Deactivate Access Key. ### Deactivate an existing access key, using a valid management key. This API endpoint allows administrators to deactivate an existing access key. Once the access key has been deactivated, it's access will be revoked until reactivated. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Deactivate Access Keys

**Slug:** `DESCOPE_DEACTIVATE_ACCESS_KEYS`

Batch Deactivate Access Keys. ### Deactivate existing access keys in batch, using a valid management key. This API endpoint allows administrators to deactivate existing access keys in batch. Once the access keys have been deactivated, their access will be revoked until reactivated. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Access Key

**Slug:** `DESCOPE_DELETE_ACCESS_KEY`

Delete Access Key. ### Delete an existing access key, using a valid management key. This API endpoint allows administrators to delete an existing access key. Once the access key has been deleted, it's access will be revoked. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete access key attribute

**Slug:** `DESCOPE_DELETE_ACCESS_KEY_ATTRIBUTE`

Delete access key attribute. Delete a single access key custom attribute definition by machine name (no-op if absent), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Delete Access Keys

**Slug:** `DESCOPE_DELETE_ACCESS_KEYS`

Batch Delete Access Keys. ### Delete existing access keys in batch, using a valid management key. This API endpoint allows administrators to delete existing access keys in batch. Once the access keys have been deleted, their access will be revoked. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete All FGA Relations

**Slug:** `DESCOPE_DELETE_ALL_FGARELATIONS`

Delete All FGA Relations. Delete all project FGA relations

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete All Test Users

**Slug:** `DESCOPE_DELETE_ALL_TEST_USERS`

Delete All Test Users. ### Delete all test users This endpoint is used to delete all test users from a project. This action will delete these users forever and they will not be recoverable. ### See Also - See [Manage Test Users](/manage/testusers/) for more information on test users.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete auth access policy rule

**Slug:** `DESCOPE_DELETE_AUTH_ACCESS_RULE`

Delete auth access policy rule. Delete a single project-level auth access policy rule by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete connector

**Slug:** `DESCOPE_DELETE_CONNECTOR`

Delete connector. Delete a single connector by id, using a valid management key. Flows that use the connector fail at that step until they are changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Required. The connector id, as CreateConnector and LoadAllConnectors return it; ids starting with `MP` are messaging providers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Descoper

**Slug:** `DESCOPE_DELETE_DESCOPER`

Delete Descoper. Delete a descoper

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete dynamic registration template

**Slug:** `DESCOPE_DELETE_DYNAMIC_REGISTRATION_TEMPLATE`

Delete dynamic registration template. Delete a dynamic registration template by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete dynamic registration templates

**Slug:** `DESCOPE_DELETE_DYNAMIC_REGISTRATION_TEMPLATES`

Delete dynamic registration templates. Delete multiple dynamic registration templates by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete engine

**Slug:** `DESCOPE_DELETE_ENGINE`

Delete engine. Delete an engine, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Family

**Slug:** `DESCOPE_DELETE_FAMILY`

Delete Family. Delete a family, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Family Custom Attribute

**Slug:** `DESCOPE_DELETE_FAMILY_CUSTOM_ATTRIBUTE`

Delete Family Custom Attribute. Delete one or more custom attribute definitions from the family entity by name, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `names` | array | No | Descope field names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Family Dependent

**Slug:** `DESCOPE_DELETE_FAMILY_DEPENDENT`

Delete Family Dependent. Delete a dependent (shadow profile) user from a family

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | the family is inferred from the dependent (dependents belong to a single family) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete FGA Backup

**Slug:** `DESCOPE_DELETE_FGABACKUP`

Delete FGA Backup. Delete an FGA backup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | Descope backupId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete FGA Relations

**Slug:** `DESCOPE_DELETE_FGARELATIONS`

Delete FGA Relations. ### Delete FGA relations This endpoint allows you to delete relations using Fine-Grained Authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tuples` | array | No | Descope field tuples. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete flow

**Slug:** `DESCOPE_DELETE_FLOW`

Delete flow. Delete a single flow by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Flow

**Slug:** `DESCOPE_DELETE_FLOWS`

Delete Flow. ### Delete a flow within a project utilizing a management key. This endpoint is used to delete a flow from a project by giving an existing flow ID to be deleted. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete JWT Template

**Slug:** `DESCOPE_DELETE_JWT_TEMPLATE`

Delete JWT Template. Delete a JWT template by id. The project's default templates are restored where this one was referenced.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List

**Slug:** `DESCOPE_DELETE_LIST`

Delete List. Delete a list by ID

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Management Key

**Slug:** `DESCOPE_DELETE_MANAGEMENT_KEYS`

Delete Management Key. Delete a management key using another management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete MCP Server Client

**Slug:** `DESCOPE_DELETE_MCP_SERVER_CLIENT`

Delete MCP Server Client. Delete an MCP Server Client by ID, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete MCP Server Clients

**Slug:** `DESCOPE_DELETE_MCP_SERVER_CLIENTS`

Delete MCP Server Clients. Delete multiple MCP Server Clients by IDs, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete template

**Slug:** `DESCOPE_DELETE_MESSAGING_TEMPLATE`

Delete template. Delete a single message template by type, method and id, using a valid management key. Deleting the active template resets the auth method's selection to the built-in System template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `type` | string | Yes | Descope type parameter. |
| `method` | string | Yes | Descope method parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an authz namespace

**Slug:** `DESCOPE_DELETE_NAMESPACE`

Delete an authz namespace. Delete an authz namespace and remove all related relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `schema_name` | string | No | optional upgrade to the schema name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete OAuth provider

**Slug:** `DESCOPE_DELETE_OAUTH_PROVIDER`

Delete OAuth provider. Delete a single OAuth provider by id (system providers are reset to disabled), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Outbound App

**Slug:** `DESCOPE_DELETE_OUTBOUND_APP`

Delete Outbound App. ### Delete outbound application This endpoint allows you to delete an outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete outbound application token by id

**Slug:** `DESCOPE_DELETE_OUTBOUND_APP_TOKEN_BY_ID`

Delete outbound application token by id. Delete outbound application token by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete outbound application tokens by appId or userId

**Slug:** `DESCOPE_DELETE_OUTBOUND_APP_USER_TOKENS`

Delete outbound application tokens by appId or userId. Delete outbound application tokens by appId or userId, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope appId parameter. |
| `user_id` | string | Yes | Descope userId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete outbound SCIM configuration

**Slug:** `DESCOPE_DELETE_OUTBOUND_SCIMCONFIGURATION`

Delete outbound SCIM configuration. Delete an outbound SCIM configuration, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Permission

**Slug:** `DESCOPE_DELETE_PERMISSION`

Delete Permission. ### Delete a permission, using a valid management key. This API endpoint allows administrators to delete an existing permission. The endpoint takes the following one parameter: - name (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `name` | string | No | Either name or id must be provided (not both). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Delete Permissions

**Slug:** `DESCOPE_DELETE_PERMISSIONS`

Bulk Delete Permissions. Bulk delete Permissions, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Permission IDs — can be combined with names or used alone. |
| `names` | array | No | Descope field names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete policy rule

**Slug:** `DESCOPE_DELETE_POLICY_RULE`

Delete policy rule. Delete a policy rule row matched by id. Idempotent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `DESCOPE_DELETE_PROJECT`

Delete Project. Delete a project, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `DESCOPE_DELETE_PROJECT_VIA_POST`

Delete Project. ### Delete a project utilizing a management key. This endpoint allows you to delete a project. This action is irreversible, use with caution. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an authz relation definition

**Slug:** `DESCOPE_DELETE_RELATION_DEFINITION`

Delete an authz relation definition. Delete an authz relation definition for your project and remove all related relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `namespace` | string | Yes | Descope field namespace. |
| `schema_name` | string | No | optional upgrade to the schema name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a list of authz relations

**Slug:** `DESCOPE_DELETE_RELATIONS`

Delete a list of authz relations. Delete a list of authz relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `relations` | array | No | Descope field relations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete all relations for a list of resources

**Slug:** `DESCOPE_DELETE_RELATIONS_FOR_RESOURCES`

Delete all relations for a list of resources. Delete all relations for the given list of resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resources` | array | No | Descope field resources. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete resource

**Slug:** `DESCOPE_DELETE_RESOURCE`

Delete resource. Delete a resource, including MCP servers (type "mcp"), using a valid management key. Resources managed by an agent gateway cannot be deleted directly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete all relations with matching resourceIds for a list of resources

**Slug:** `DESCOPE_DELETE_RESOURCE_RELATIONS_FOR_RESOURCES`

Delete all relations with matching resourceIds for a list of resources. Delete all relations for the given list of resources in which they are the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resources` | array | No | Descope field resources. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete resources batch

**Slug:** `DESCOPE_DELETE_RESOURCES`

Delete resources batch. Delete multiple resources, including MCP servers (type "mcp"), using a valid management key. Resources managed by an agent gateway cannot be deleted directly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Role

**Slug:** `DESCOPE_DELETE_ROLE`

Permanently delete one project-level or tenant-scoped Descope role by name or ID. This irreversible operation cannot be undone and can immediately revoke authorization from users assigned to the role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the role to permanently delete. Provide exactly one of name or role_id. |
| `role_id` | string | No | ID of the role to permanently delete. Provide exactly one of role_id or name. |
| `tenant_id` | string | No | Tenant ID when deleting a tenant-scoped role. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Delete Roles

**Slug:** `DESCOPE_DELETE_ROLES`

Batch Delete Roles. ### Delete roles in batch, using a valid management key. This API endpoint allows administrators to delete roles in batch. The endpoint takes the following one parameter: - roleNames (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_ids` | array | No | Role IDs — can be combined with roleNames or used alone. |
| `tenant_id` | string | No | Descope field tenantId. |
| `role_names` | array | No | Descope field roleNames. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an authz schema

**Slug:** `DESCOPE_DELETE_SCHEMA`

Delete an authz schema. Delete an authz schema thus removing authz from your project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Scope Claim Mapping

**Slug:** `DESCOPE_DELETE_SCOPE_CLAIM_MAPPING`

Delete Scope Claim Mapping. Remove the project-wide scope-to-claims mapping.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete session classification

**Slug:** `DESCOPE_DELETE_SESSION_CLASSIFICATION`

Delete session classification. Delete a session classification by name, using a valid management key. Users assigned to it are left without a group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Application

**Slug:** `DESCOPE_DELETE_SSOAPPLICATION`

Delete Application. ### Delete an Application within a project This endpoint deletes an Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SSO application custom attribute definitions

**Slug:** `DESCOPE_DELETE_SSOAPPLICATION_CUSTOM_ATTRIBUTE`

Delete SSO application custom attribute definitions. Delete SSO application custom attribute definitions, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `names` | array | No | Descope field names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SSO application permission

**Slug:** `DESCOPE_DELETE_SSOAPPLICATION_PERMISSION`

Delete SSO application permission. Delete an SSO application permission by application id and permission id, using a valid management key. The permission is detached from any roles that reference it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `app_id` | string | Yes | Descope appId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SSO application role

**Slug:** `DESCOPE_DELETE_SSOAPPLICATION_ROLE`

Delete SSO application role. Delete an SSO application role by application id and role id, using a valid management key. Any user or service account assignments of the role are removed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `app_id` | string | Yes | Descope appId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tenant's SAML/OIDC Settings

**Slug:** `DESCOPE_DELETE_SSOSETTINGS`

Delete Tenant's SAML/OIDC Settings. ### Delete the current SAML/OIDC configuration settings of a tenant, using a valid management key. This API endpoint allows you to delete the current SAML/OIDC configuration settings of a tenant. Use this with caution as this endpoint deletes the configuration and is irreversible. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope ssoId parameter. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tenant

**Slug:** `DESCOPE_DELETE_TENANT`

Permanently delete one Descope tenant. This irreversible operation cannot be undone. By default, users and access keys associated only with the tenant are preserved; cascade=true permanently deletes those identities and keys too.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cascade` | boolean | No | Whether to also permanently delete users and access keys associated only with this tenant. Leave false to preserve those identities and keys; set true only when their deletion is explicitly intended. |
| `tenant_id` | string | Yes | ID of the Descope tenant to permanently delete. This operation cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete tenant attribute

**Slug:** `DESCOPE_DELETE_TENANT_ATTRIBUTE`

Delete tenant attribute. Delete a single tenant custom attribute definition by machine name (no-op if absent), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete tenant auth access policy rule

**Slug:** `DESCOPE_DELETE_TENANT_AUTH_ACCESS_RULE`

Delete tenant auth access policy rule. Delete a single tenant-level auth access policy rule by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tenants Batch

**Slug:** `DESCOPE_DELETE_TENANTS_BATCH`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | Descope field ids. |
| `cascade` | boolean | No | Descope field cascade. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tenant Theme

**Slug:** `DESCOPE_DELETE_TENANT_THEME`

Delete Tenant Theme. Delete a tenant's theme, using a valid management key. Flows for that tenant render with the project theme again. Returns 404 when the tenant has no theme of its own.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete third party application

**Slug:** `DESCOPE_DELETE_THIRD_PARTY_APPLICATION`

Delete third party application. Delete a third party application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete third party application consents

**Slug:** `DESCOPE_DELETE_THIRD_PARTY_APPLICATION_CONSENTS`

Delete third party application consents. Delete OAuth user consents for [Inbound Apps](/identity-federation/inbound-apps). Provide `consentIds`, or filter by `appId`, `userIds`, and optional `tenantId`. To revoke [agentic identities](/agentic-identity-hub/core-components/agents), use [Revoke agentic identities](/api/management/agentic-identity-hub/revoke-agentic-identities) instead — it scopes deletion to agentic consents and supports `clientId` and `resourceId` filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | No | Descope field appId. |
| `user_ids` | array | No | Descope field userIds. |
| `tenant_id` | string | No | Descope field tenantId. |
| `consent_ids` | array | No | Descope field consentIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch delete third party applications

**Slug:** `DESCOPE_DELETE_THIRD_PARTY_APPLICATIONS`

Batch delete third party applications. Delete multiple third party applications in batch, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete third party application consents by tenant

**Slug:** `DESCOPE_DELETE_THIRD_PARTY_APPLICATION_TENANT_CONSENTS`

Delete third party application consents by tenant. Delete all OAuth user consents for an [Inbound App](/identity-federation/inbound-apps) within a tenant. Provide `tenantId` and optional `appId` or `consentIds`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | No | Descope field appId. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `consent_ids` | array | No | Descope field consentIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User

**Slug:** `DESCOPE_DELETE_USER`

Delete User. ### Delete a user, using a valid management key. This API endpoint will delete a user utilizing a valid management key based on the provided user loginId. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Descope field userId. |
| `login_id` | string | No | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete user attribute

**Slug:** `DESCOPE_DELETE_USER_ATTRIBUTE`

Delete user attribute. Delete a single user custom attribute definition by machine name (no-op if absent), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Custom Attributes

**Slug:** `DESCOPE_DELETE_USER_CUSTOM_ATTRIBUTE`

Delete a Custom Attributes. ### Delete a custom attributes to configure on users within a project, using a valid management key. This API endpoint will delete a custom attribute within a project. ### See also - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `names` | array | No | Descope field names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Family-Scoped User Custom Attribute

**Slug:** `DESCOPE_DELETE_USER_FAMILY_SCOPED_CUSTOM_ATTRIBUTE`

Delete Family-Scoped User Custom Attribute. Delete one or more family-scoped user custom attribute definitions by name, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `names` | array | No | Descope field names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Delete Users

**Slug:** `DESCOPE_DELETE_USERS`

Batch Delete Users. ### Delete users, using a valid management key. This API endpoint will delete users utilizing a valid management key. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_ids` | array | No | Descope field userIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete widget

**Slug:** `DESCOPE_DELETE_WIDGET`

Delete widget. Delete a single widget by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate an authz schema and preview the changes

**Slug:** `DESCOPE_DRY_RUN_SCHEMA`

Validate an authz schema and preview the changes. Preview schema diff between existing and new schema, without saving it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dsl` | string | Yes | Descope field dsl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Embedded Link

**Slug:** `DESCOPE_EMBEDDED_LINK_SIGNIN`

Generate Embedded Link. ### Generate an embedded link for an existing user Initiate a sign-in process by generating an embdedded link for an existing user utilizing a management key. The endpoint will return a token which can then be verified using the Magic Link [Verify Token](/api/magic-link/verification/verify-token) endpoint. ### Next Steps Verify the embedded link token using the [Verify Token](/api/magic-link/verification/verify-token) endpoint. ### See Also - See [Embedded link Authentication](/customize/auth/embeddedlink/) for details about implementing embedded links. - See [The User Object](/api/overview#the-user-object) for further details on how to identify users and their contact information such as email addresses and phone number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timeout` | integer | No | Descope field timeout. |
| `login_id` | string | Yes | Descope field loginId. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate a token for user sign up, later can be verified with magiclink

**Slug:** `DESCOPE_EMBEDDED_LINK_SIGNUP`

Generate a token for user sign up, later can be verified with magiclink. Generate a token for user sign up

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | No | Descope field user. |
| `timeout` | integer | No | Descope field timeout. |
| `login_id` | string | Yes | Descope field loginId. |
| `login_options` | object | No | Descope field loginOptions. |
| `email_verified` | boolean | No | Descope field emailVerified. |
| `phone_verified` | boolean | No | Descope field phoneVerified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Expire User Passwsord

**Slug:** `DESCOPE_EXPIRE_USER_PASSWORD`

Expire User Passwsord. ### Expire an existing user's password, using a valid management key. This API endpoint allows you to expire an existing user's password. Upon next login, the user will need to follow the reset password flow. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants. - See [Reset Password](/api/passwords/email/password-reset) for sending the password reset email. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Flow

**Slug:** `DESCOPE_EXPORT_FLOW`

Export Flow. ### Export an existing flow from a project utilizing a management key. This endpoint is used to export an existing flow from a project. The response is the JSON which includes the flow and associated screens. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Descope field flowId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Flow Localization

**Slug:** `DESCOPE_EXPORT_FLOW_LOCALIZATION`

Export Flow Localization. Export flow localization, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Descope field flowId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Messaging Localization

**Slug:** `DESCOPE_EXPORT_MESSAGING_TEMPLATE_LOCALIZATION`

Export Messaging Localization. Export messaging localization, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Descope template ID used by this operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Project

**Slug:** `DESCOPE_EXPORT_PROJECT`

Export Project. ### Export a project utilizing a management key. This endpoint is used to export a project. The response is the JSON of the project items. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string | No | Descope field format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Project Snapshot

**Slug:** `DESCOPE_EXPORT_SNAPSHOT`

Export Project Snapshot. ### Export a project snapshot utilizing a management key. This endpoint allows you to export a snapshot of the current project state. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string | No | Descope field format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Theme

**Slug:** `DESCOPE_EXPORT_THEME`

Export Theme. ### Export a theme from a project utilizing a management key. This endpoint is used to export a theme from a project. The response is the JSON of the theme. ### See Also - See [Styles Overview](/management/project-settings/styles) for more information on styles and themes

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Latest Outbound App Tenant Token

**Slug:** `DESCOPE_FETCH_LATEST_OUTBOUND_APP_TENANT_TOKEN`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Fetch Latest Outbound App Tenant Token. ### Fetch latest outbound application tenant token This endpoint allows you to fetch the latest tenant token for an outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `options` | object | No | Descope field options. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `external_identifier` | string | No | Descope field externalIdentifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Latest Outbound App User Token

**Slug:** `DESCOPE_FETCH_LATEST_OUTBOUND_APP_USER_TOKEN`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Fetch Latest Outbound App User Token. ### Fetch latest outbound application user token This endpoint allows you to fetch the latest user token for an outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `options` | object | No | Descope field options. |
| `user_id` | string | No | Descope field userId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `external_identifier` | string | No | Descope field externalIdentifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Outbound App Tenant Token

**Slug:** `DESCOPE_FETCH_OUTBOUND_APP_TENANT_TOKEN`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Fetch Outbound App Tenant Token. ### Fetch outbound application tenant token This endpoint allows you to fetch the tenant token for an outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `scopes` | array | No | Descope field scopes. |
| `options` | object | No | Descope field options. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `external_identifier` | string | No | Descope field externalIdentifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Outbound App User Token

**Slug:** `DESCOPE_FETCH_OUTBOUND_APP_USER_TOKEN`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Fetch Outbound App User Token. ### Fetch outbound application user token This endpoint allows you to fetch the user token for an outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `scopes` | array | No | Descope field scopes. |
| `options` | object | No | Descope field options. |
| `user_id` | string | No | Descope field userId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `external_identifier` | string | No | Descope field externalIdentifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Enchanted Link

**Slug:** `DESCOPE_GENERATE_ENCHANTED_LINK_FOR_TEST_USER`

Generate Enchanted Link. ### Generate a Enchanted Link for a test user. This endpoint is used to generate a Enchanted Link for a test user. You can define whether this is sent via email or sms. Once you generate the Enchanted Link Token must be verified via [verify token](/api/enchanted-link/verify-token) ### See Also - See [Enchanted link Authentication](/api/enchantedlink/) for details about implementing enchanted links. - See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test user. - See [Manage Test Users](/manage/testusers/) for more information on test users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | No | Descope field loginId. |
| `redirect_url` | string | No | Descope field redirectUrl. |
| `login_options` | object | No | Descope field loginOptions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate JWT for Sign-In

**Slug:** `DESCOPE_GENERATE_JWTSIGN_IN`

Generate JWT for Sign-In. Generate a JWT for an existing user, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jwt` | string | No | Descope field jwt. |
| `mfa` | boolean | No | Descope field mfa. |
| `stepup` | boolean | No | Descope field stepup. |
| `login_id` | string | Yes | Descope field loginId. |
| `sso_app_id` | string | No | Descope field ssoAppId. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |
| `ignore_enforce_sso` | boolean | No | Keep the tenants the user already belongs to that enforce SSO. They are left out of the JWT by default, because this endpoint does not authenticate through SSO. Applies to existing memberships only: a new user whose email domain would self-provision into a tenant that enforces SSO is still refused. |
| `selected_tenant_id` | string | No | Descope field selectedTenantId. |
| `revoke_other_sessions` | boolean | No | Descope field revokeOtherSessions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate JWT for Sign-Up

**Slug:** `DESCOPE_GENERATE_JWTSIGN_UP`

Generate JWT for Sign-Up. Create a new user and generate a JWT for them, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | No | Descope field user. |
| `login_id` | string | Yes | Descope field loginId. |
| `sso_app_id` | string | No | Descope field ssoAppId. |
| `user_tenants` | array | No | Descope field userTenants. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `email_verified` | boolean | No | Descope field emailVerified. |
| `phone_verified` | boolean | No | Descope field phoneVerified. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |
| `ignore_enforce_sso` | boolean | No | Keep the tenants the user already belongs to that enforce SSO. They are left out of the JWT by default, because this endpoint does not authenticate through SSO. Applies to existing memberships only: a new user whose email domain would self-provision into a tenant that enforces SSO is still refused. |
| `selected_tenant_id` | string | No | Descope field selectedTenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate JWT for Sign-Up or Sign-In

**Slug:** `DESCOPE_GENERATE_JWTSIGN_UP_OR_IN`

Generate JWT for Sign-Up or Sign-In. Create a new user and generate a JWT for them, or just generate a JWT if the user already exists. Uses a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | No | Descope field user. |
| `login_id` | string | Yes | Descope field loginId. |
| `sso_app_id` | string | No | Descope field ssoAppId. |
| `user_tenants` | array | No | Descope field userTenants. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `email_verified` | boolean | No | Descope field emailVerified. |
| `phone_verified` | boolean | No | Descope field phoneVerified. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |
| `ignore_enforce_sso` | boolean | No | Keep the tenants the user already belongs to that enforce SSO. They are left out of the JWT by default, because this endpoint does not authenticate through SSO. Applies to existing memberships only: a new user whose email domain would self-provision into a tenant that enforces SSO is still refused. |
| `selected_tenant_id` | string | No | Descope field selectedTenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Magic Link

**Slug:** `DESCOPE_GENERATE_MAGIC_LINK_FOR_TEST_USER`

Generate Magic Link. ### Generate a Magic Link for a test user. This endpoint is used to generate a Magic Link for a test user. You can define whether this is sent via email or sms. Once you generate the Magic Link Token must be verified via [verify token](/api/magic-link/verification/verify-token) ### See Also - See [Magic link Authentication](/api/magiclink/) for details about implementing magic links. - See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test user. - See [Manage Test Users](/manage/testusers/) for more information on test users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | No | Descope field loginId. |
| `redirect_url` | string | No | Descope field redirectUrl. |
| `login_options` | object | No | Descope field loginOptions. |
| `delivery_method` | string | Yes | Descope field deliveryMethod. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate OTP

**Slug:** `DESCOPE_GENERATE_OTPFOR_TEST_USER`

Generate OTP. ### Generate an OTP verification code for a test user. This endpoint is used to generate an OTP verification code for a test user. You can define whether this is sent via email or sms. Once you generate the OTP code, you must verify the OTP code via [verify OTP email](/api/otp/email/verify-otp) or [verify OTP sms](/api/otp/sms/verify-otp) ### See Also - See [OTP Authentication](/api/otp/) for details about implementing OTP. - See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test user. - See [Manage Test Users](/manage/testusers/) for more information on test users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | No | Descope field loginId. |
| `login_options` | object | No | Descope field loginOptions. |
| `delivery_method` | string | Yes | Descope field deliveryMethod. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate SSO Admin Link

**Slug:** `DESCOPE_GENERATE_TENANT_ADMIN_LINK_SSO`

Generate SSO Admin Link. ### Generate an SSO admin link for a tenant, using a valid management key. This API endpoint generates an SSO admin link that allows a tenant administrator to configure SSO settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Descope field email. |
| `sso_id` | string | No | Descope field ssoId. |
| `actor_id` | string | No | Optional: recorded as the audit actor for actions performed inside the SSO Setup Suite (instead of the temporary user). Used as-is for audit attribution and not validated. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `expire_time` | string | No | Descope field expireTime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get access key attribute

**Slug:** `DESCOPE_GET_ACCESS_KEY_ATTRIBUTE`

Get access key attribute. Get a single access key custom attribute definition by machine name, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get admin portal settings

**Slug:** `DESCOPE_GET_ADMIN_PORTAL_SETTINGS`

Get admin portal settings. Get the project's admin portal settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Lists

**Slug:** `DESCOPE_GET_ALL_LISTS`

Get All Lists. Get all lists

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get auth access policy rule

**Slug:** `DESCOPE_GET_AUTH_ACCESS_RULE`

Get auth access policy rule. Get a single project-level auth access policy rule by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get auth access policy settings

**Slug:** `DESCOPE_GET_AUTH_ACCESS_SETTINGS`

Get auth access policy settings. Get the project-level auth access policy settings: the default action and the full rule evaluation order, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Clone Project Process

**Slug:** `DESCOPE_GET_CLONE_PROJECT_PROCESS`

Get Clone Project Process. Get the status of an asynchronous clone project process. This returns an object describing the new project details or an error if the process failed, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `process_id` | string | Yes | Descope processId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get connector

**Slug:** `DESCOPE_GET_CONNECTOR`

Get connector. Get a single connector by id, using a valid management key, with its configuration. Secret values are returned as `PLACEHOLDER_VALUE`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Required. The connector id, as CreateConnector and LoadAllConnectors return it; ids starting with `MP` are messaging providers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get connector template

**Slug:** `DESCOPE_GET_CONNECTOR_TEMPLATE`

Get connector template. Get one connector template by id, using a valid management key, with its configuration fields: each field's name, type, whether it is required, its default value, its allowed values, the field it depends on, and its documentation. Build the `configuration` for CreateConnector from these fields; the server checks it against them. Secret values come from the user: don't invent them unless the user asks for a placeholder. An `httpAuth` value is an object with `method` and that method's settings: `none`; `bearerToken` with `bearerToken`; `apiKey` with `apiKey: {key, token}`; `basic` with `basic: {username, password}`; `oauth2ClientCredentials` with `oauth2ClientCredentials: {clientId, clientSecret, authUrl, authStyle}`, all required, where `authStyle` is `body` or `header` with no default, plus optional `scopes` as one space-separated string. A `secret-object` value is a list of `{key, value, secret}` entries; `secret` defaults to false, and a secret entry is read b

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The template id, such as `http`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Descoper

**Slug:** `DESCOPE_GET_DESCOPER`

Get Descoper. Get a descoper

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get embedded link settings

**Slug:** `DESCOPE_GET_EMBEDDED_LINK_SETTINGS`

Get embedded link settings. Get the project's embedded link settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get enchanted link settings

**Slug:** `DESCOPE_GET_ENCHANTED_LINK_SETTINGS`

Get enchanted link settings. Get the project's enchanted link settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Family Custom Attributes

**Slug:** `DESCOPE_GET_FAMILY_CUSTOM_ATTRIBUTES`

Get Family Custom Attributes. Get the family entity's custom attribute definitions, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Family Settings

**Slug:** `DESCOPE_GET_FAMILY_SETTINGS`

Get Family Settings. Get the project's family account settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get FGA Backup

**Slug:** `DESCOPE_GET_FGABACKUP`

Get FGA Backup. Get an FGA backup by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | Descope backupId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mappable Resources

**Slug:** `DESCOPE_GET_FGA_MAPPABLE_RESOURCES`

Get Mappable Resources. ### Get mappable resources This endpoint allows you to retrieve mappable resources for Fine-Grained Authorization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mappable Schema

**Slug:** `DESCOPE_GET_FGAMAPPABLE_SCHEMA`

Get Mappable Schema. ### Get mappable schema This endpoint allows you to retrieve the mappable schema for Fine-Grained Authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |
| `resources_limit` | string | No | Descope resourcesLimit parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get FGA Schema

**Slug:** `DESCOPE_GET_FGASCHEMA`

Get FGA Schema. ### Get FGA schema This endpoint allows you to retrieve the current Fine-Grained Authorization schema for your project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get flow

**Slug:** `DESCOPE_GET_FLOW`

Get flow. Get a single flow by id in its exported representation, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get governance access request

**Slug:** `DESCOPE_GET_GOVERNANCE_ACCESS_REQUEST`

Get governance access request. Load a single Agentic Governance Suite access request by id, using a valid management key. Requires the Agentic Governance Suite in the company license.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get governance settings

**Slug:** `DESCOPE_GET_GOVERNANCE_SETTINGS`

Get governance settings. Load the project's Agentic Governance Suite settings, using a valid management key. Works without the Agentic Governance Suite in the company license, and returns the stored settings or the defaults.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List

**Slug:** `DESCOPE_GET_LIST`

Get List. Get a list by ID

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List By Name

**Slug:** `DESCOPE_GET_LIST_BY_NAME`

Get List By Name. Get a list by name

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get magic link settings

**Slug:** `DESCOPE_GET_MAGIC_LINK_SETTINGS`

Get magic link settings. Get the project's magic link settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Management Flow async result

**Slug:** `DESCOPE_GET_MANAGEMENT_FLOW_ASYNC_RESULT`

Get Management Flow async result. Get the result from an async management flow execution (if any), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `execution_id` | string | No | Descope field executionId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Management Key

**Slug:** `DESCOPE_GET_MANAGEMENT_KEY`

Get Management Key. Get a management key using another management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MCP Server Client Secret

**Slug:** `DESCOPE_GET_MCP_SERVER_CLIENT_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Get MCP Server Client Secret. Get MCP Server Client secret, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get template

**Slug:** `DESCOPE_GET_MESSAGING_TEMPLATE`

Get template. Get a single message template by type, method and id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `type` | string | Yes | Descope type parameter. |
| `method` | string | Yes | Descope method parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Return the list of targets and resources changed since the given date

**Slug:** `DESCOPE_GET_MODIFIED`

Return the list of targets and resources changed since the given date. Return the list of targets and resources changed since the given date. Should be used to invalidate local caches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string | No | Changed since given milli epoch UTC time - optional, default to max changelog (change events) TTL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OAuth provider

**Slug:** `DESCOPE_GET_OAUTH_PROVIDER`

Get OAuth provider. Get a single OAuth provider by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OAuth settings

**Slug:** `DESCOPE_GET_OAUTH_SETTINGS`

Get OAuth settings. Get the project's general OAuth settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OTP settings

**Slug:** `DESCOPE_GET_OTPSETTINGS`

Get OTP settings. Get the project's one-time passcode settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get passkey settings

**Slug:** `DESCOPE_GET_PASSKEY_SETTINGS`

Get passkey settings. Get the project's passkey (WebAuthn) settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tenant Password Settings

**Slug:** `DESCOPE_GET_PASSWORD_SETTINGS`

Get Tenant Password Settings. ### Get password settings for a tenant This endpoint allows you to get the password settings of a given tenant. ### See Also - See [tenant password settings](/customize/tenant#passwords) for details about tenant password settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | No | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get password settings

**Slug:** `DESCOPE_GET_PASSWORD_SETTINGS_V2`

Get password settings. Get the project's password settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project settings

**Slug:** `DESCOPE_GET_PROJECT_SETTINGS`

Get project settings. Get the project's settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scope Claim Mapping

**Slug:** `DESCOPE_GET_SCOPE_CLAIM_MAPPING`

Get Scope Claim Mapping. Get the project-wide mapping of OIDC scopes to JWT claims. Returns an empty mapping when none has been configured.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get session classification

**Slug:** `DESCOPE_GET_SESSION_CLASSIFICATION`

Get session classification. Get a single session classification by name, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SSO application permission

**Slug:** `DESCOPE_GET_SSOAPPLICATION_PERMISSION`

Get SSO application permission. Get a single SSO application permission by application id and permission id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `app_id` | string | Yes | Descope appId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SSO application role

**Slug:** `DESCOPE_GET_SSOAPPLICATION_ROLE`

Get SSO application role. Get a single SSO application role by application id and role id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `app_id` | string | Yes | Descope appId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SSO application secret by application ID

**Slug:** `DESCOPE_GET_SSOAPPLICATION_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Get SSO application secret by application ID. Get the dedicated OIDC client secret of an SSO application by its ID, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `secret_name` | string | No | Descope secretName parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SSO settings

**Slug:** `DESCOPE_GET_SSOSETTINGS`

Get SSO settings. Get the project's SSO settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Authenticated SSO Admin Link

**Slug:** `DESCOPE_GET_TENANT_ADMIN_LINK_SSOFOR_AUTHENTICATED_USERS`

Authenticated SSO Admin Link. ### Authenticated SSO admin link for a tenant, using a valid management key. This API endpoint handles authenticated SSO admin link requests for a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate tenant admin SSO configuration links (batch)

**Slug:** `DESCOPE_GET_TENANT_ADMIN_LINKS_SSOFOR_AUTHENTICATED_USERS`

Generate tenant admin SSO configuration links (batch). Get default SSO admin link plus per-ssoId admin links for authenticated users only, using a valid management key

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_ids` | array | No | Descope field ssoIds. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tenant attribute

**Slug:** `DESCOPE_GET_TENANT_ATTRIBUTE`

Get tenant attribute. Get a single tenant custom attribute definition by machine name, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tenant auth access policy rule

**Slug:** `DESCOPE_GET_TENANT_AUTH_ACCESS_RULE`

Get tenant auth access policy rule. Get a single tenant-level auth access policy rule by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tenant auth access policy settings

**Slug:** `DESCOPE_GET_TENANT_AUTH_ACCESS_SETTINGS`

Get tenant auth access policy settings. Get the tenant-level auth access policy settings: the default action and the full rule evaluation order, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OTP Settings for a tenant

**Slug:** `DESCOPE_GET_TENANT_OTPSETTINGS`

Get OTP Settings for a tenant. Get OTP Settings for a tenant, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tenant Session Settings

**Slug:** `DESCOPE_GET_TENANT_SETTINGS`

Get Tenant Session Settings. ### Get session settings for a tenant This endpoint allows you to get the session settings of a given tenant. ### See Also - See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tenant Theme

**Slug:** `DESCOPE_GET_TENANT_THEME`

Get Tenant Theme. Get the styles a tenant overrides the project theme with, using a valid management key. The logo is returned as a base64 data URI, so the response can be sent back to Set Tenant Theme unchanged. Returns 404 when the tenant has no theme of its own, in which case flows for that tenant render with the project theme.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get third party application secret

**Slug:** `DESCOPE_GET_THIRD_PARTY_APPLICATION_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Get third party application secret. Get a third party application secret, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |
| `secret_name` | string | No | Descope secretName parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TOTP settings

**Slug:** `DESCOPE_GET_TOTPSETTINGS`

Get TOTP settings. Get the project's TOTP settings, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `DESCOPE_GET_USER`

Retrieve one user by login ID or Descope user ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Descope user ID. Provide exactly one of user_id or login_id. |
| `login_id` | string | No | User login ID. Provide exactly one of login_id or user_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user attribute

**Slug:** `DESCOPE_GET_USER_ATTRIBUTE`

Get user attribute. Get a single user custom attribute definition by machine name, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope name parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Family-Scoped User Custom Attributes

**Slug:** `DESCOPE_GET_USER_FAMILY_SCOPED_CUSTOM_ATTRIBUTES`

Get Family-Scoped User Custom Attributes. Get the project's family-scoped user custom attribute definitions, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Provider Token

**Slug:** `DESCOPE_GET_USER_PROVIDER_TOKEN`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Get User Provider Token. ### Get an existing user's provider token, using a valid management key. This API endpoint will loads the user's access token generated by the OAuth/OIDC provider, using a valid management key. When querying for OAuth providers, this only applies when utilizing your own account with the provider and have selected `Manage tokens from provider` selected under the [social auth methods](https://app.descope.com/settings/authentication/social). ### Query Params - `loginId` - The loginId of the user you want to get the provider token for. - `provider` - The provider you want to get the token for. - `withRefreshToken (optional)` - set to true to also return the refresh token. - `forceRefresh (optional)` - set to true to force a refresh of the token. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [Th

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope loginId parameter. |
| `provider` | string | Yes | Descope provider parameter. |
| `force_refresh` | boolean | No | Descope forceRefresh parameter. |
| `with_refresh_token` | boolean | No | Descope withRefreshToken parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get well-known settings

**Slug:** `DESCOPE_GET_WELL_KNOWN_SETTINGS`

Get well-known settings. Get the project's customization of its OIDC discovery documents (the project document and the shared inbound apps document), using a valid management key. Returns the defaults when nothing was saved.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get widget

**Slug:** `DESCOPE_GET_WIDGET`

Get widget. Get a single widget by id in its exported representation, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check a list of relation queries

**Slug:** `DESCOPE_HAS_RELATIONS`

Check a list of relation queries. Check a list of relation queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `relation_queries` | array | No | Descope field relationQueries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Impersonate User

**Slug:** `DESCOPE_IMPERSONATE`

Impersonate User. ### Impersonate a user, using a valid management key. This API endpoint will allow you to impersonate a user using a login ID. The impersonator user must have the impersonation permission in order for this request to work. The response would be a refresh JWT of the impersonated user

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `impersonator_id` | string | Yes | Descope field impersonatorId. |
| `selected_tenant` | string | No | Descope field selectedTenant. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |
| `validate_consent` | boolean | No | Descope field validateConsent. |
| `session_cookie_name` | string | No | Descope field sessionCookieName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Impersonate Family Dependent

**Slug:** `DESCOPE_IMPERSONATE_FAMILY_DEPENDENT`

Impersonate Family Dependent. Impersonate a family dependent. The impersonator (by user ID) must be a member of the dependent's family and hold the family impersonate-dependents permission there.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `selected_family` | string | No | optional family to scope the impersonated session to (stamped as the current-family claim); when set it must be the dependent's family. Omitted -> the impersonated session carries no current-family claim |
| `dependent_login_id` | string | Yes | the target dependent, by login ID |
| `impersonator_user_id_or_login_id` | string | Yes | the impersonator (acting family admin), by user ID or login ID; must be a member of the dependent's family and hold the family impersonate-dependents permission there |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Impersonate Stepup

**Slug:** `DESCOPE_IMPERSONATE_STEPUP`

Impersonate Stepup. Impersonate as a different user with step-up claim

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `impersonator_id` | string | Yes | Descope field impersonatorId. |
| `selected_tenant` | string | No | Descope field selectedTenant. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |
| `validate_consent` | boolean | No | Descope field validateConsent. |
| `session_cookie_name` | string | No | Descope field sessionCookieName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Access Key

**Slug:** `DESCOPE_IMPORT_ACCESS_KEYS`

Import Access Key. Import an access key by providing its plaintext value, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keys` | array | Yes | Descope field keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Flow

**Slug:** `DESCOPE_IMPORT_FLOW`

Import Flow. ### Import a flow within a project utilizing a management key. This endpoint is used to import a flow to a project. The request items for the `flow` and `screen` this endpoint can be received from the export flow endpoint. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow` | object | Yes | Used by managementservice snapshots - make sure not to break compatibility |
| `changelog` | string | No | Descope field changelog. |
| `skip_render` | boolean | No | Descope field skipRender. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Flow Localization

**Slug:** `DESCOPE_IMPORT_FLOW_LOCALIZATION`

Import Flow Localization. Import flow localization, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Descope field flowId. |
| `overrides` | object | Yes | Descope field overrides. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Lists

**Slug:** `DESCOPE_IMPORT_LISTS`

Import Lists. Import multiple lists

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lists` | array | No | Descope field lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Messaging Localization

**Slug:** `DESCOPE_IMPORT_MESSAGING_LOCALIZATION`

Import Messaging Localization. Import messaging localization, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `overrides` | object | Yes | Descope field overrides. |
| `template_id` | string | Yes | Descope template ID used by this operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Project

**Slug:** `DESCOPE_IMPORT_PROJECT`

Import Project. ### Import a project utilizing a management key. This endpoint is used to import a project. The argument of `files` should be the output of the [export project endpoint](/api/management/projects/export-project) You can also exclude items from the export when importing by utilizing the flags below within the `exclude` array. ``` The entire project: project Project specific items: project.domain project.trustedDomains project.tokenResponseMethod project.selfProvisioning project.rotateJwt project.cookiepolicy project.refreshTokenExpiration project.stepupTokenExpiration project.sessionTokenExpiration project.keySessionTokenExpiration project.inviteUrl project.inviteEmail project.inviteSms project.inviteMagicLink project.conformanceJwt project.inactivity Auth Methods, Flows, styles, etc: magicLink enchantedLink embeddedLink otp totp sso oauth webauthn password styles flows connectors authorization attributes ssoApps ``` You can also import secrets for connectors and OAuth Pr

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | object | Yes | Descope field files. |
| `excludes` | array | No | Descope field excludes. |
| `input_secrets` | object | No | Descope field inputSecrets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Project Snapshot

**Slug:** `DESCOPE_IMPORT_SNAPSHOT`

Import Project Snapshot. ### Import a project snapshot utilizing a management key. This endpoint allows you to import a previously exported project snapshot. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | object | Yes | Descope field files. |
| `excludes` | array | No | Descope field excludes. |
| `input_secrets` | object | No | Descope field inputSecrets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Theme

**Slug:** `DESCOPE_IMPORT_THEME`

Import Theme. ### Import a theme to a project utilizing a management key. This endpoint is used to import a theme from a project. The request body for this endpoint can be received from the export theme endpoint. ### See Also - See [Styles Overview](/management/project-settings/styles) for more information on styles and themes

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `theme` | object | Yes | Used by managementservice snapshots - make sure not to break compatibility |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import User Passkeys

**Slug:** `DESCOPE_IMPORT_USER_PASSKEYS`

Import User Passkeys. Import passkey credentials for a user, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `devices` | array | Yes | Descope field devices. |
| `login_id` | string | Yes | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Descopers

**Slug:** `DESCOPE_LIST_DESCOPERS`

List Descopers. List descopers

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List FGA Backups

**Slug:** `DESCOPE_LIST_FGABACKUPS`

List FGA Backups. List all FGA backups.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List/Search Flows

**Slug:** `DESCOPE_LIST_FLOWS`

List/Search Flows. ### List or search flows within a project utilizing a management key. This endpoint is used to list or search flows within a project. To list all flows, send an empty body such as: `{ }` or `{ "ids": [] }`. To search for a flow or several flows, send a body with the flowIds you want to search such as `{ "ids": ["sign-in"] }` or `{ "ids": ["sign-in", "sign-up"] }`. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Descope field ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Flow Templates

**Slug:** `DESCOPE_LIST_FLOW_TEMPLATES`

List Flow Templates. List all available flow templates

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List JWT Template Library

**Slug:** `DESCOPE_LIST_JWT_TEMPLATE_LIBRARY`

List JWT Template Library. List the curated JWT template library Descope ships — starter templates with documented use cases, optional logos, and `experimental` flags.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List JWT Templates

**Slug:** `DESCOPE_LIST_JWT_TEMPLATES`

List JWT Templates. List every JWT template defined on the current project. Returns full field detail for each — name, description, type (key|user), tags, claim body, authSchema, issuerType, etc.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Permissions

**Slug:** `DESCOPE_LIST_PERMISSIONS`

Return all project permissions, including IDs, descriptions, and system-default status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `DESCOPE_LIST_PROJECT`

List Projects. ### List all projects utilizing a management key. This endpoint allows you to list all projects in your account. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Roles

**Slug:** `DESCOPE_LIST_ROLES`

Return all project-level and tenant-scoped roles with their granted permission names.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Trusted Devices

**Slug:** `DESCOPE_LIST_TRUSTED_DEVICES_FOR_USERS`

List Trusted Devices. List trusted devices for one or more users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifiers` | array | No | The users' login identifiers (external ID or ID). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Outbound Apps with User Token

**Slug:** `DESCOPE_LIST_USER_OUTBOUND_APPS_WITH_VALID_USER_TOKEN`

List Outbound Apps with User Token. ### List outbound applications with user token This endpoint allows you to retrieve outbound applications that have a user token available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Descope userId parameter. |
| `tenant_id` | string | No | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Passkeys

**Slug:** `DESCOPE_LIST_USER_PASSKEYS`

List User Passkeys. List all passkeys for a user, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all widgets

**Slug:** `DESCOPE_LIST_WIDGETS`

List all widgets. List all widgets in project

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load An Access Key

**Slug:** `DESCOPE_LOAD_ACCESS_KEY`

Load An Access Key. ### Load an access key, using a valid management key. This API endpoint allows administrators to load the details of an existing access key. The response contains details of the access key including associated roles and tenants as well as details of the key's creation, status, and expiration. ### Next Steps Once you have this data, you can utilize the response to [Update an access key](/api/management/access-keys/update-access-key), [Activate an access key](/api/management/access-keys/activate-access-key), [Deactivate an access key](/api/management/access-keys/deactivate-access-key), or [Delete an access key](/api/management/access-keys/delete-access-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all auth access policy rules

**Slug:** `DESCOPE_LOAD_ALL_AUTH_ACCESS_RULES`

Load all auth access policy rules. Load all project-level auth access policy rules in evaluation order, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all connectors

**Slug:** `DESCOPE_LOAD_ALL_CONNECTORS`

Load all connectors. Load all of the project's connectors, using a valid management key. Each connector is returned as GetConnector returns it, with its configuration and with secret values as `PLACEHOLDER_VALUE`. This includes messaging provider connectors, whose ids start with `MP`, and leaves out connectors that Descope manages internally, such as outbound SCIM connectors, as the console does.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all connector templates

**Slug:** `DESCOPE_LOAD_ALL_CONNECTOR_TEMPLATES`

Load all connector templates. Load the connector templates the project can create connectors from, using a valid management key. Each template's `id` is the `type` to pass to CreateConnector, and `name` is its display name. Templates are returned without their fields; call GetConnectorTemplate for one template's configuration fields before creating a connector. Internal and early-release templates are not listed, and a template with a `requiredLicense` is listed only when the company has that license. Messaging providers such as `sendgrid` have no template and are not listed. SSO and social login (OAuth) providers are not connectors; they have their own operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all dynamic registration templates

**Slug:** `DESCOPE_LOAD_ALL_DYNAMIC_REGISTRATION_TEMPLATES`

Load all dynamic registration templates. Load all dynamic registration templates, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all resources

**Slug:** `DESCOPE_LOAD_ALL_RESOURCES`

Load all resources. Load all resources, using a valid management key. MCP servers are the resources with type "mcp".

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all session classifications

**Slug:** `DESCOPE_LOAD_ALL_SESSION_CLASSIFICATIONS`

Load all session classifications. Load all session classifications in the project, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load All Applications

**Slug:** `DESCOPE_LOAD_ALL_SSOAPPLICATIONS`

Load All Applications. ### Load all Applications within a project This endpoint returns details of all Applications within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all SSO Settings for a tenant

**Slug:** `DESCOPE_LOAD_ALL_SSOSETTINGS`

Load all SSO Settings for a tenant. Load all SSO Settings for a tenant, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all tenant auth access policy rules

**Slug:** `DESCOPE_LOAD_ALL_TENANT_AUTH_ACCESS_RULES`

Load all tenant auth access policy rules. Load all tenant-level auth access policy rules in evaluation order, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load All Tenants

**Slug:** `DESCOPE_LOAD_ALL_TENANTS`

Load All Tenants. ### Load all tenants, using a valid management key. This API endpoint returns details of all configured tenants within the Descope instance. The response includes an array of the tenants and these details for each tenant: - id - name - selfProvisioningDomains ### Next Steps - Once you have this data, you can utilize the response to add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load All third party applications

**Slug:** `DESCOPE_LOAD_ALL_THIRD_PARTY_APPLICATIONS`

Load All third party applications. Loads all project third party applications, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Descope page parameter. |
| `limit` | integer | No | Descope limit parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all third party applications (v2)

**Slug:** `DESCOPE_LOAD_ALL_THIRD_PARTY_APPLICATIONS_V2`

Load all third party applications (v2). Loads all third party applications in the structured scope-claim mapping model, using a valid management key. Legacy attributesScopes are converted to scopeClaimMapping and returned empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Descope field page. |
| `limit` | integer | No | Descope field limit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load dynamic registration template

**Slug:** `DESCOPE_LOAD_DYNAMIC_REGISTRATION_TEMPLATE`

Load dynamic registration template. Load a dynamic registration template by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load engine by ID

**Slug:** `DESCOPE_LOAD_ENGINE`

Load engine by ID. Load an engine by ID, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load all engines

**Slug:** `DESCOPE_LOAD_ENGINES`

Load all engines. Load all engines for the project, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load All Members of a specific External Group

**Slug:** `DESCOPE_LOAD_GROUP_MEMBERS`

Load All Members of a specific External Group. ### Load all members of a specific External group, using a valid management key. This API endpoint allows administrators to load all members of a specific external group that is associated to a tenant. The response contains an array of group objects including the group id, display name, and an array of associated members. ### Next Steps Administrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-group), [Update an Existing SCIM Group (adding new members)](/api/management/tenants/scim/update-scim-group), or [Delete an Existing SCIM Group](/api/management/tenants/scim/delete-scim-group) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Optional: return the group only if it came from this SSO configuration (ssoId). Use the reserved id "default_ssoid" for the tenant's default SSO configuration. |
| `group_id` | string | No | Descope field groupId. |
| `tenant_id` | string | No | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load All External Groups for a Tenant

**Slug:** `DESCOPE_LOAD_GROUPS`

Load All External Groups for a Tenant. ### Load all external groups for a tenant, using a valid management key. This API endpoint allows administrators to load all external groups that are associated to a tenant. The response contains an array of group objects including the group id, display name, and an array of associated members. ### Next Steps Administrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-group), [Update an Existing SCIM Group (adding new members)](/api/management/tenants/scim/update-scim-group), or [Delete an Existing SCIM Group](/api/management/tenants/scim/delete-scim-group) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Optional: return only groups from this SSO configuration (ssoId). Empty returns all the tenant's groups. Use the reserved id "default_ssoid" for the tenant's default SSO configuration. |
| `tenant_id` | string | No | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load JWT Template

**Slug:** `DESCOPE_LOAD_JWT_TEMPLATE`

Load JWT Template. Load a single JWT template by id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load JWT Template Library Entry

**Slug:** `DESCOPE_LOAD_JWT_TEMPLATE_LIBRARY_ENTRY`

Load JWT Template Library Entry. Load a single library entry by id, including the full claim body — required before applying.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load MCP Server Client

**Slug:** `DESCOPE_LOAD_MCP_SERVER_CLIENT`

Load MCP Server Client. Load an MCP Server Client by ID, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `client_id` | string | No | Descope field clientId. |
| `mcp_server_id` | string | No | Descope field mcpServerId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load All External Groups for Specific Members

**Slug:** `DESCOPE_LOAD_MEMBER_GROUPS`

Load All External Groups for Specific Members. ### Load all external group for specific members, using a valid management key. This API endpoint allows administrators to load all external groups for specific members associated with a specific tenant. The tenantId is required and the loginId or userId are optional for further filtering. The response contains an array of group objects including the group id, display name, and an array of associated members. ### Next Steps Administrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-group), [Update an Existing SCIM Group (adding new members)](/api/management/tenants/scim/update-scim-group), or [Delete an Existing SCIM Group](/api/management/tenants/scim/delete-scim-group) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Optional: return only groups from this SSO configuration (ssoId). Use the reserved id "default_ssoid" for the tenant's default SSO configuration. |
| `user_ids` | array | No | Descope field userIds. |
| `login_ids` | array | No | Descope field loginIds. |
| `tenant_id` | string | No | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Outbound App by ID

**Slug:** `DESCOPE_LOAD_OUTBOUND_APP`

Get Outbound App by ID. ### Get outbound application by ID This endpoint allows you to retrieve a specific outbound application by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All Outbound Apps

**Slug:** `DESCOPE_LOAD_OUTBOUND_APPS`

List All Outbound Apps. ### List all outbound applications This endpoint allows you to retrieve all outbound applications configured in your project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load outbound SCIM configuration

**Slug:** `DESCOPE_LOAD_OUTBOUND_SCIMCONFIGURATION`

Load outbound SCIM configuration. Load an outbound SCIM configuration by id. Response merges connector config with webhook status (enabled flag, last export/processing times, failure counter).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope appId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load policy rule

**Slug:** `DESCOPE_LOAD_POLICY_RULE`

Load policy rule. Load a single policy rule row by id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load policy rule settings

**Slug:** `DESCOPE_LOAD_POLICY_RULE_SETTINGS`

Load policy rule settings. Load the project-level policy rule settings (default action).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load Project

**Slug:** `DESCOPE_LOAD_PROJECT`

Load Project. Load the project's name, environment and tags, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load resource by ID

**Slug:** `DESCOPE_LOAD_RESOURCE`

Load resource by ID. Load a resource by ID, including MCP servers (type "mcp"), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load resource by URI

**Slug:** `DESCOPE_LOAD_RESOURCE_BY_URI`

Load resource by URI. Load a resource by URI, using a valid management key. For an MCP server, the URI is the MCP server URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uri` | string | Yes | Descope uri parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load FGA Resources

**Slug:** `DESCOPE_LOAD_RESOURCES_DETAILS`

Load FGA Resources. ### Load FGA resources This endpoint allows you to load resources for Fine-Grained Authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_identifiers` | array | Yes | Descope field resourceIdentifiers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load an authz schema

**Slug:** `DESCOPE_LOAD_SCHEMA`

Load an authz schema. Load an authz schema for your project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load SCIM Access Keys

**Slug:** `DESCOPE_LOAD_SCIMACCESS_KEYS`

Load SCIM Access Keys. Load the SCIM access keys of a tenant, using a valid management key. Returns key metadata only - the cleartext of an access key is available exactly once, when the key is created or rotated, and is never returned again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Omit to return the tenant's SCIM keys across every SSO configuration. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load Application by ID

**Slug:** `DESCOPE_LOAD_SSOAPPLICATION`

Load Application by ID. ### Load Application by ID within a project This endpoint returns details of a specific Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tenant's SAML/OIDC Settings

**Slug:** `DESCOPE_LOAD_SSOSETTINGS`

Get Tenant's SAML/OIDC Settings. ### Get the current SAML/OIDC configuration settings of a tenant, using a valid management key. This API endpoint allows you to get the current SAML/OIDC configuration settings of a tenant. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope ssoId parameter. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load Tenant By ID

**Slug:** `DESCOPE_LOAD_TENANT`

Load Tenant By ID. ### Load tenant by ID, using a valid management key. This API endpoint returns details of the tenant within the Descope instance that matches the ID provided. The response includes an array of the tenants and these details for each tenant: - id - name - selfProvisioningDomains ### Next Steps - Once you have this data, you can utilize the response to add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope id parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load third party application by ID

**Slug:** `DESCOPE_LOAD_THIRD_PARTY_APPLICATION`

Load third party application by ID. Loads project third party application by id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope id parameter. |
| `client_id` | string | No | Descope clientId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load third party application by ID (v2)

**Slug:** `DESCOPE_LOAD_THIRD_PARTY_APPLICATION_V2`

Load third party application by ID (v2). Loads a third party application by id in the structured scope-claim mapping model, using a valid management key. Legacy attributesScopes are converted to scopeClaimMapping and returned empty.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope id parameter. |
| `client_id` | string | No | Descope clientId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load Users

**Slug:** `DESCOPE_LOAD_USERS`

Load Users. Load users by their IDs, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_ids` | array | No | max len will be validated in app level, so we can control it with an env var |
| `include_invalid_users` | boolean | No | Descope field includeInvalidUsers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Log user out of all sessions

**Slug:** `DESCOPE_LOGOUT_ALL_USER_DEVICES`

Log user out of all sessions. ### Log a user out of all sessions, using a valid management key. This API endpoint allows you to log a user out of all active sessions. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Descope field userId. |
| `login_id` | string | No | Descope field loginId. |
| `session_types` | array | No | Descope field sessionTypes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Logout Users from All Devices

**Slug:** `DESCOPE_LOGOUT_ALL_USERS_DEVICES`

Logout Users from All Devices. Log multiple users out from all of their active sessions, using a valid management key. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifiers` | array | No | The users' login identifiers (external ID or ID). |
| `session_types` | array | No | Descope field sessionTypes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create New SSO Settings

**Slug:** `DESCOPE_NEW_SSOSETTINGS_REQUEST`

Create New SSO Settings. ### Create new SSO settings for a tenant, using a valid management key. This API endpoint allows you to create a new SSO configuration for a tenant. The endpoint accepts the tenant ID, an optional SSO ID, and a display name for the SSO configuration. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `display_name` | string | Yes | Descope field displayName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch third party application

**Slug:** `DESCOPE_PATCH_THIRD_PARTY_APPLICATION`

Patch third party application. Patch a third party application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | No | Descope field name. |
| `logo_url` | string | No | Descope field logoUrl. |
| `force_par` | boolean | No | Descope field forcePar. |
| `force_dpop` | boolean | No | Descope field forceDpop. |
| `force_mtls` | boolean | No | Descope field forceMtls. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | Descope field clientType. |
| `description` | string | No | Descope field description. |
| `ciba_enabled` | boolean | No | cibaEnabled allows the CIBA grant (urn:openid:params:grant-type:ciba) for this app and requires cibaSettings. Default false. A public client cannot use this grant. |
| `jar_settings` | object | No | JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications |
| `rar_settings` | object | No | Descope field rarSettings. |
| `ciba_settings` | object | No | Descope field cibaSettings. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `default_audience` | string | No | Descope field defaultAudience. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `attributes_scopes` | array | No | Descope field attributesScopes. |
| `client_assertions` | array | No | clientAssertions replaces the stored list when provided; absent preserves it. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `audience_whitelist` | array | No | Descope field audienceWhitelist. |
| `client_auth_method` | string | No | clientAuthMethod: "clientSecret" (default when empty), "privateKeyJwt" (only clientAssertions are accepted), "workloadIdentity" (only workloadClientAssertions are accepted) or "mtls" (only a registered mTLS certificate is accepted). |
| `connections_scopes` | array | No | Descope field connectionsScopes. |
| `permissions_scopes` | array | No | Descope field permissionsScopes. |
| `jwt_bearer_disabled` | boolean | No | jwtBearerDisabled rejects the JWT bearer grant (urn:ietf:params:oauth:grant-type:jwt-bearer) for this app. Default false. A public client cannot use this grant. |
| `jwt_bearer_settings` | object | No | string backChannelLogoutUrl = 10 [(validate).string = {url: true, optional: true}]; |
| `scope_claim_mapping` | array | No | scopeClaimMapping replaces the stored mapping when provided; when absent the existing mapping is preserved. Consumed by PatchThirdPartyApplicationV2; v1 preserves the legacy attributesScopes. |
| `allow_partial_scopes` | boolean | No | Descope field allowPartialScopes. |
| `device_code_disabled` | boolean | No | deviceCodeDisabled rejects the device authorization grant (urn:ietf:params:oauth:grant-type:device_code) for this app. Default false. |
| `id_jag_target_clients` | object | No | idJagTargetClients replaces the stored mapping when provided. An absent field preserves it, and so does an empty map: a protobuf map has no presence, so it reaches the service as nil after the gRPC hop. Clear the mapping through the full update, which always writes the field. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `refresh_token_disabled` | boolean | No | refreshTokenDisabled rejects the refresh_token grant for this app, so its tokens cannot be refreshed. Default false. |
| `token_exchange_disabled` | boolean | No | tokenExchangeDisabled rejects the token exchange grant (urn:ietf:params:oauth:grant-type:token-exchange) for this app. Default false. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `workload_client_assertions` | array | No | workloadClientAssertions replaces the stored list when provided; absent preserves it. |
| `authorization_code_disabled` | boolean | No | authorizationCodeDisabled rejects the authorization_code grant for this app, including its authorization requests. Default false. |
| `client_credentials_disabled` | boolean | No | clientCredentialsDisabled rejects the client_credentials grant for this app. Default false. A public client cannot use this grant. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch third party application (v2)

**Slug:** `DESCOPE_PATCH_THIRD_PARTY_APPLICATION_V2`

Patch third party application (v2). Patch a third party application using the structured scope-claim mapping model, using a valid management key. Only the fields present in the request change; the legacy attributesScopes field is cleared.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | No | Descope field name. |
| `logo_url` | string | No | Descope field logoUrl. |
| `force_par` | boolean | No | Descope field forcePar. |
| `force_dpop` | boolean | No | Descope field forceDpop. |
| `force_mtls` | boolean | No | Descope field forceMtls. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | Descope field clientType. |
| `description` | string | No | Descope field description. |
| `ciba_enabled` | boolean | No | cibaEnabled allows the CIBA grant (urn:openid:params:grant-type:ciba) for this app and requires cibaSettings. Default false. A public client cannot use this grant. |
| `jar_settings` | object | No | JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications |
| `rar_settings` | object | No | Descope field rarSettings. |
| `ciba_settings` | object | No | Descope field cibaSettings. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `default_audience` | string | No | Descope field defaultAudience. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `client_assertions` | array | No | clientAssertions replaces the stored list when provided; absent preserves it. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `audience_whitelist` | array | No | Descope field audienceWhitelist. |
| `client_auth_method` | string | No | clientAuthMethod: "clientSecret" (default when empty), "privateKeyJwt" (only clientAssertions are accepted), "workloadIdentity" (only workloadClientAssertions are accepted) or "mtls" (only a registered mTLS certificate is accepted). |
| `connections_scopes` | array | No | Descope field connectionsScopes. |
| `permissions_scopes` | array | No | Descope field permissionsScopes. |
| `jwt_bearer_disabled` | boolean | No | jwtBearerDisabled rejects the JWT bearer grant (urn:ietf:params:oauth:grant-type:jwt-bearer) for this app. Default false. A public client cannot use this grant. |
| `jwt_bearer_settings` | object | No | Descope field jwtBearerSettings. |
| `scope_claim_mapping` | array | No | scopeClaimMapping replaces the stored mapping when provided; when absent the existing mapping is preserved. Either way the legacy attributesScopes are cleared (v2 write-replace). |
| `allow_partial_scopes` | boolean | No | Descope field allowPartialScopes. |
| `device_code_disabled` | boolean | No | deviceCodeDisabled rejects the device authorization grant (urn:ietf:params:oauth:grant-type:device_code) for this app. Default false. |
| `id_jag_target_clients` | object | No | idJagTargetClients replaces the stored mapping when provided. An absent field preserves it, and so does an empty map: a protobuf map has no presence, so it reaches the service as nil after the gRPC hop. Clear the mapping through the full update, which always writes the field. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `refresh_token_disabled` | boolean | No | refreshTokenDisabled rejects the refresh_token grant for this app, so its tokens cannot be refreshed. Default false. |
| `token_exchange_disabled` | boolean | No | tokenExchangeDisabled rejects the token exchange grant (urn:ietf:params:oauth:grant-type:token-exchange) for this app. Default false. |
| `mtls_client_auth_methods` | object | No | mtlsClientAuthMethods replaces the stored certificates when set; absent keeps them. |
| `workload_client_assertions` | array | No | workloadClientAssertions replaces the stored list when provided; absent preserves it. |
| `authorization_code_disabled` | boolean | No | authorizationCodeDisabled rejects the authorization_code grant for this app, including its authorization requests. Default false. |
| `client_credentials_disabled` | boolean | No | clientCredentialsDisabled rejects the client_credentials grant for this app. Default false. A public client cannot use this grant. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch User

**Slug:** `DESCOPE_PATCH_USER`

Patch User. ### Patch a user's details, using a valid management key. This API endpoint will patch a user's details of a user utilizing a valid management key. Additionally, you can patch a user with multiple login IDs by passing an array of loginIds in string format within the `additionalIdentifiers` key. This allows you to add additional login identifiers to an existing user without performing a full user update. <Callout title="Important" type="warn"> When adding additional identifiers to a user who has an SSO login ID, the user may be able to authenticate outside of SSO whenever SSO is not enforced and non-SSO methods (such as magic link or password) are available. See [Risks in Merging SSO and Non-SSO Identities](/sso/merging-sso-identities-risk) before using this field on SSO users. </Callout> ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `email` | string | No | Descope field email. |
| `phone` | string | No | Descope field phone. |
| `status` | string | No | Descope field status. |
| `picture` | string | No | Descope field picture. |
| `login_id` | string | No | Descope field loginId. |
| `given_name` | string | No | Descope field givenName. |
| `role_names` | array | No | Project-level role names for the user. Omit this field to leave the user's roles unchanged, send an empty array to remove all of them, or send an array of role names to replace them. |
| `family_name` | string | No | Descope field familyName. |
| `middle_name` | string | No | Descope field middleName. |
| `sso_app_ids` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `user_tenants` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `recovery_email` | string | No | Descope field recoveryEmail. |
| `recovery_phone` | string | No | Descope field recoveryPhone. |
| `verified_email` | boolean | No | Descope field verifiedEmail. |
| `verified_phone` | boolean | No | Descope field verifiedPhone. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `family_associations` | string | No | absent/null means "don't touch families"; a list (even empty) replaces the full family membership. each AssociatedFamily entry carries its own roleNames and familyScopedAttributes |
| `additional_identifiers` | array | No | Descope field additionalIdentifiers. |
| `session_classification` | string | No | The session classification to assign the user to, by name. Omit the field to leave the current assignment untouched, send an empty string to remove it, and send a name to assign that classification. A name that does not match an existing classification is rejected. |
| `verified_recovery_email` | boolean | No | Descope field verifiedRecoveryEmail. |
| `verified_recovery_phone` | boolean | No | Descope field verifiedRecoveryPhone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Users Batch

**Slug:** `DESCOPE_PATCH_USER_BATCH`

Patch Users Batch. Patch users in batch, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | No | Descope field users. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Recalculate SSO Mappings

**Slug:** `DESCOPE_RECALCULATE_SSOMAPPINGS`

Recalculate SSO Mappings. Recalculate SSO group to role mappings for all users in a tenant, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove IPs from List

**Slug:** `DESCOPE_REMOVE_IPS_FROM_LIST`

Remove IPs from List. Remove one or more IPs from an existing IP list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `ips` | array | Yes | Descope field ips. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove SSO User from Tenant

**Slug:** `DESCOPE_REMOVE_SSOSUFFIX_FROM_EXTERNAL_ID`

Remove SSO User from Tenant. ### Remove an SSO user from a tenant, using a valid management key. This API endpoint removes an SSO user's association with a tenant. ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Texts from List

**Slug:** `DESCOPE_REMOVE_TEXTS_FROM_LIST`

Remove Texts from List. Remove one or more text items from an existing text list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `texts` | array | Yes | Descope field texts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove User Passkey

**Slug:** `DESCOPE_REMOVE_USER_PASSKEY`

Remove User Passkey. Remove a specific passkey for a user by credential ID, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `credential_id` | string | Yes | Descope field credentialId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User's Passkeys

**Slug:** `DESCOPE_REMOVE_USER_PASSKEYS`

Delete User's Passkeys. ### Delete a user's Passkeys, using a valid management key. This API endpoint will delete all existing passkeys for the user ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `credential_id` | string | No | Descope field credentialId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove User Recovery Codes

**Slug:** `DESCOPE_REMOVE_USER_RECOVERY_CODES`

Remove User Recovery Codes. Remove (revoke) all recovery codes for a user, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | The user's login ID (external ID) or user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User's TOTP Seed

**Slug:** `DESCOPE_REMOVE_USER_TOTP`

Delete User's TOTP Seed. ### Delete an existing user's TOTP, using a valid management key. This API endpoint allows you to delete an existing user's TOTP seed. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reorder auth access policy rule

**Slug:** `DESCOPE_REORDER_AUTH_ACCESS_RULE`

Reorder auth access policy rule. Move a project-level auth access policy rule to a 1-based position in the evaluation order. Rules in between shift accordingly. Returns all rules in their new order, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `position` | integer | Yes | Descope field position. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reorder a policy rule

**Slug:** `DESCOPE_REORDER_POLICY_RULE`

Reorder a policy rule. Move one policy rule to a 1-based position in the evaluation order; rules in between shift accordingly. Rules are evaluated first-match in this order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | Descope field ruleId. |
| `position` | integer | Yes | Descope field position. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reorder tenant auth access policy rule

**Slug:** `DESCOPE_REORDER_TENANT_AUTH_ACCESS_RULE`

Reorder tenant auth access policy rule. Move a tenant-level auth access policy rule to a 1-based position in the tenant evaluation order. Rules in between shift accordingly. Returns all rules in their new order, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `position` | integer | Yes | Descope field position. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tenant

**Slug:** `DESCOPE_REPLACE_TENANT`

Update Tenant. ### Update a tenant, using a valid management key. This API endpoint will update a tenant utilizing a valid management key. Utilizing this API endpoint will allow you to update the name or selfProvisioningDomains settings of the tenant. ### Next Steps - You can then add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `disabled` | boolean | No | Descope field disabled. |
| `auth_type` | string | No | deprecated - authType should be set via ConfigureTenantSettings |
| `enforce_sso` | boolean | No | Descope field enforceSSO. |
| `approved_domains` | string | No | The tenant's vanity hostname (e.g. surveys.example.com), unique across the project's tenants. Requests that reach the project through its trusted proxy on this hostname are bound to this tenant. One item for now A list of hostnames, absent keeps the current value and an empty list clears it |
| `role_inheritance` | string | No | Descope field roleInheritance. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `federated_app_ids` | array | No | Descope field federatedAppIds. |
| `enforce_ssoexclusions` | array | No | Descope field enforceSSOExclusions. |
| `self_provisioning_domains` | array | No | Descope field selfProvisioningDomains. |
| `enforce_ssoexclusion_permissions` | array | No | Permission names or IDs whose holders in the tenant may sign in without SSO while enforceSSO is on (break-glass accounts) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve governance access request

**Slug:** `DESCOPE_RESOLVE_GOVERNANCE_ACCESS_REQUEST`

Resolve governance access request. Approve or deny a pending Agentic Governance Suite access request, using a valid management key. Approving provisions the requested agent client. The resolution is attributed to the Management API. Requires the Agentic Governance Suite in the company license.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `action` | string | Yes | "approve" or "deny". |
| `resolution_note` | string | No | Optional note recorded with the resolution. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load a list of defined relations for the given resource

**Slug:** `DESCOPE_RESOURCE_RELATIONS`

Load a list of defined relations for the given resource. Load a list of defined relations for the given resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource` | string | Yes | Descope field resource. |
| `ignore_target_set_relations` | boolean | No | Descope field ignoreTargetSetRelations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore FGA Backup

**Slug:** `DESCOPE_RESTORE_FGABACKUP`

Restore FGA Backup. Restore from an FGA backup. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backup_id` | string | Yes | Descope field backupId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke agentic identities

**Slug:** `DESCOPE_REVOKE_AGENTIC_IDENTITIES`

Revoke agentic identities. Revoke agentic identities and invalidate their consents — the same operation as [revoking access in the Console](/agentic-identity-hub/core-components/agents#revoking-access). Combine filters to narrow scope: - `clientId` + `userId` — one user's grant to a specific agent - `consentId` + `userId` — a specific consent for a user - `resourceId` + `userId` — all of a user's grants on one MCP server [Resource](/resources) - `userId` alone — all agentic identities for that user across every MCP server Returns the number of identities revoked in `revoked`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Descope field userId. |
| `client_id` | string | No | Descope field clientId. |
| `consent_id` | string | No | Descope field consentId. |
| `resource_id` | string | No | Descope field resourceId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke SCIM Access Keys

**Slug:** `DESCOPE_REVOKE_SCIMACCESS_KEYS`

Revoke SCIM Access Keys. Revoke every SCIM access key of a tenant for the given SSO configuration, using a valid management key. This disables SCIM provisioning for that tenant until a new key is created and configured in the identity provider. Use revokeMode DEACTIVATE to suspend the keys reversibly instead of deleting them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | The SSO configuration to revoke. Omit it to target the tenant's default configuration - it does NOT mean "every configuration", so a tenant with several SSO configurations keeps provisioning through the keys of the ones not named here. Call LoadSCIMAccessKeys first to see which configurations hold keys. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `revoke_mode` | string ("SCIM_KEY_REVOKE_MODE_DELETE" | "SCIM_KEY_REVOKE_MODE_DEACTIVATE") | No | How the keys are taken out of service. SCIM_KEY_REVOKE_MODE_DELETE (0, the default) deletes them permanently. SCIM_KEY_REVOKE_MODE_DEACTIVATE (1) disables them reversibly, so they can be restored later with Activate SCIM Access Keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke a named SSO application secret

**Slug:** `DESCOPE_REVOKE_SSOAPPLICATION_SECRET`

Revoke a named SSO application secret. Revoke a named OIDC client secret of an SSO application, using a valid management key. Returns the remaining secret metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `app_id` | string | Yes | Descope field appId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke SSO Admin Link

**Slug:** `DESCOPE_REVOKE_TENANT_ADMIN_LINK_SSO`

Revoke SSO Admin Link. ### Revoke an SSO admin link for a tenant, using a valid management key. This API endpoint revokes an existing SSO admin link for a tenant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke a named third party application secret

**Slug:** `DESCOPE_REVOKE_THIRD_PARTY_APPLICATION_SECRET`

Revoke a named third party application secret. Revoke a named client secret of a third party application, using a valid management key. Returns the remaining secret metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | Yes | Descope field name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate Access Key

**Slug:** `DESCOPE_ROTATE_ACCESS_KEY`

Rotate Access Key. Rotate an access key — regenerates the secret for an existing access key while preserving the same key ID, name, roles, tenants, expiry and metadata. The new cleartext is returned exactly once and the previous secret stops working immediately. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate engine secret

**Slug:** `DESCOPE_ROTATE_ENGINE_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Rotate engine secret. Rotate an engine's secret, returning the new secret. The previous secret is immediately invalidated. Requires a valid management key. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate MCP Server Client Secret

**Slug:** `DESCOPE_ROTATE_MCP_SERVER_CLIENT_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Rotate MCP Server Client Secret. Rotate MCP Server Client secret, using a valid management key. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate SCIM Access Key

**Slug:** `DESCOPE_ROTATE_SCIMACCESS_KEY`

Rotate SCIM Access Key. Rotate the SCIM access keys of a tenant, using a valid management key. A new key is created and the tenant's existing SCIM keys for the same SSO configuration are revoked, either deleted or deactivated according to revokeMode. Update the identity provider with the new bearer token immediately - until you do, SCIM provisioning for that tenant will fail. The cleartext is returned exactly once. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `sso_id` | string | No | The SSO configuration to rotate. Omit it to target the tenant's default configuration - it does NOT mean "every configuration", so a tenant with several SSO configurations keeps provisioning through the keys of the ones not named here. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `description` | string | No | Descope field description. |
| `expire_time` | string | No | Descope field expireTime. |
| `revoke_mode` | string ("SCIM_KEY_REVOKE_MODE_DELETE" | "SCIM_KEY_REVOKE_MODE_DEACTIVATE") | No | How the keys being replaced are taken out of service. SCIM_KEY_REVOKE_MODE_DELETE (0, the default) deletes them permanently. SCIM_KEY_REVOKE_MODE_DEACTIVATE (1) disables them reversibly, so they can be restored later with Activate SCIM Access Keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate SSO application secret by application ID

**Slug:** `DESCOPE_ROTATE_SSOAPPLICATION_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Rotate SSO application secret by application ID. Rotate the dedicated OIDC client secret of an SSO application by its ID, using a valid management key. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate third party application secret by application ID

**Slug:** `DESCOPE_ROTATE_THIRD_PARTY_APPLICATION_SECRET`

Returns sensitive reusable credentials or tokens. Expose the result only to an explicitly authorized caller and never log it. Rotate third party application secret by application ID. Rotate the project third party application secret by the application id, using a valid management key. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Management Flow

**Slug:** `DESCOPE_RUN_MANAGEMENT_FLOW`

Run Management Flow. Run a management flow, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | No | Descope field flowId. |
| `options` | object | No | Descope field options. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Management Flow asynchronously

**Slug:** `DESCOPE_RUN_MANAGEMENT_FLOW_ASYNC`

Run Management Flow asynchronously. Run a management flow asynchronously, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | No | Descope field flowId. |
| `options` | object | No | Descope field options. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save an authz namespace

**Slug:** `DESCOPE_SAVE_NAMESPACE`

Save an authz namespace. Save (create or update) an authz namespace for your project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `old_name` | string | No | Old name if we are renaming the namespace |
| `namespace` | object | No | Descope field namespace. |
| `schema_name` | string | No | optional upgrade to the schema name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save an authz relation definition

**Slug:** `DESCOPE_SAVE_RELATION_DEFINITION`

Save an authz relation definition. Save (create or update) an authz relation definition for your project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `old_name` | string | No | Old name if we are renaming the relation definition |
| `namespace` | string | Yes | Descope field namespace. |
| `schema_name` | string | No | optional upgrade to the schema name |
| `relation_definition` | object | No | Descope field relationDefinition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save FGA Resources

**Slug:** `DESCOPE_SAVE_RESOURCES_DETAILS`

Save FGA Resources. ### Save FGA resources This endpoint allows you to save resources for Fine-Grained Authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resources_details` | array | Yes | Descope field resourcesDetails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save an authz schema

**Slug:** `DESCOPE_SAVE_SCHEMA`

Save an authz schema. Save (create or update) an authz schema for your project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schema_` | object | No | Descope field schema. |
| `upgrade` | boolean | No | Descope field upgrade. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Access Keys

**Slug:** `DESCOPE_SEARCH_ACCESS_KEYS`

Search Access Keys. ### Search access keys, using a valid management key. This API endpoint allows administrators to search for details of existing access keys for a given array of tenants. The response contains an array of details for the access keys returned by the search including associated roles and tenants as well as details of the key's creation, status, and expiration. ### Next Steps Once you have this data, you can utilize the response to [Update an access key](/api/management/access-keys/update-access-key), [Activate an access key](/api/management/access-keys/activate-access-key), [Deactivate an access key](/api/management/access-keys/deactivate-access-key), or [Delete an access key](/api/management/access-keys/delete-access-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Descope field sort. |
| `text` | string | No | Descope field text. |
| `tenant_ids` | array | No | Descope field tenantIds. |
| `bound_user_id` | string | No | Descope field boundUserId. |
| `creating_user` | string | No | Descope field creatingUser. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search agentic identities

**Slug:** `DESCOPE_SEARCH_AGENTIC_IDENTITIES`

Search agentic identities. List [agentic identities](/agentic-identity-hub/core-components/agents) — authorization records that bind an OAuth client to a user, tenant, or autonomous client. Filter by `clientId`, `resourceId`, `userId`, or `consentId`. Returns consent details, agent name, resource ID, and client ID for each identity. Use `page` (zero-based) and `limit` for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number starting with 0 for the first page |
| `limit` | integer | No | Descope field limit. |
| `user_id` | string | No | Descope field userId. |
| `client_id` | string | No | Descope field clientId. |
| `consent_id` | string | No | Descope field consentId. |
| `resource_id` | string | No | Descope field resourceId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Analytics

**Slug:** `DESCOPE_SEARCH_ANALYTICS`

Search Analytics. Search analytics (summarized) data grouped by time periods, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Descope field to. |
| `geos` | array | No | Descope field geos. |
| `from_` | string | No | Descope field from. |
| `actions` | array | No | Descope field actions. |
| `devices` | array | No | Descope field devices. |
| `methods` | array | No | Descope field methods. |
| `tenants` | array | No | Descope field tenants. |
| `group_by_geo` | boolean | No | Descope field groupByGeo. |
| `group_by_action` | boolean | No | Descope field groupByAction. |
| `group_by_device` | boolean | No | Descope field groupByDevice. |
| `group_by_method` | boolean | No | Descope field groupByMethod. |
| `group_by_tenant` | boolean | No | Descope field groupByTenant. |
| `excluded_actions` | array | No | Descope field excludedActions. |
| `group_by_created` | string | No | Descope field groupByCreated. |
| `group_by_referrer` | boolean | No | Descope field groupByReferrer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Audit Events

**Slug:** `DESCOPE_SEARCH_AUDIT_EVENTS`

Search sensitive project audit events with identity, tenant, action, network, text, and time filters; returns one zero-based page. Results may contain personal data, addresses, headers, device details, and nested request metadata. Handle them as sensitive. Descope limits audit search to 10 requests per 60 seconds; honor Retry-After before retrying.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `geos` | array | No | Match any of these geographic values. |
| `page` | integer | No | Zero-based audit page number. |
| `size` | integer | No | Number of audit events in this page. |
| `text` | string | No | Full-text audit search. |
| `levels` | array | No | Match any of these audit levels. |
| `actions` | array | No | Match any of these audit action names. |
| `devices` | array | No | Match any of these device values. |
| `methods` | array | No | Match any of these authentication methods. |
| `to_time` | string | No | Inclusive audit end time in the provider-supported timestamp format. |
| `user_ids` | array | No | Match events for any of these Descope user IDs. |
| `actor_ids` | array | No | Match any of these actor IDs. |
| `from_time` | string | No | Inclusive audit start time in the provider-supported timestamp format. |
| `no_tenants` | boolean | No | When true, include events without a tenant association alongside any tenant-scoped results selected by the other filters. |
| `tenant_ids` | array | No | Match events for any of these tenant IDs. |
| `audit_types` | array | No | Match any of these audit types. |
| `external_ids` | array | No | Match any of these external login IDs. |
| `oldest_first` | boolean | No | Sort oldest events first instead of newest first. |
| `search_fields` | array | No | Custom-attribute filters with field, values or value, optional negation, and provider value type. |
| `excluded_actions` | array | No | Exclude these audit action names. |
| `remote_addresses` | array | No | Match any of these source network addresses. |
| `login_ids_contain` | array | No | Include events whose login IDs contain any supplied value. |
| `excluded_external_ids` | array | No | Exclude events for these external IDs. |
| `login_ids_not_contain` | array | No | Exclude events whose login IDs contain any supplied value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Families

**Slug:** `DESCOPE_SEARCH_FAMILIES`

Search Families. Search families, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Descope field page. |
| `size` | integer | No | Descope field size. |
| `free_text` | string | No | Descope field freeText. |
| `family_ids` | array | No | Descope field familyIds. |
| `family_names` | array | No | Descope field familyNames. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search for FGA mappable resources

**Slug:** `DESCOPE_SEARCH_FGAMAPPABLE_RESOURCES`

Search for FGA mappable resources. Search for FGA mappable resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_id` | string | Yes | Descope field tenantId. |
| `resources_limit` | string | No | Descope field resourcesLimit. |
| `resources_queries` | array | No | Descope field resourcesQueries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search governance access requests

**Slug:** `DESCOPE_SEARCH_GOVERNANCE_ACCESS_REQUESTS`

Search governance access requests. Search the project's Agentic Governance Suite access requests, with filtering, sorting and paging, using a valid management key. Requires the Agentic Governance Suite in the company license.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 0-based page number, used with limit. |
| `sort` | array | No | Sort order. Defaults to newest first. |
| `text` | string | No | Free-text search across the request's text fields. |
| `limit` | integer | No | Maximum number of requests to return. 0 returns all matches. |
| `search_fields` | array | No | Per-field filters, combined with AND. Unknown fields are ignored. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Management Keys

**Slug:** `DESCOPE_SEARCH_MANAGEMENT_KEYS`

Search Management Keys. Search management keys using another management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search MCP Server Clients

**Slug:** `DESCOPE_SEARCH_MCP_SERVER_CLIENTS`

Search MCP Server Clients. Search MCP Server Clients for a specific MCP Server, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Descope field tag. |
| `name` | string | No | Descope field name. |
| `page` | integer | No | Descope field page. |
| `sort` | array | No | Descope field sort. |
| `text` | string | No | Descope field text. |
| `limit` | integer | No | Descope field limit. |
| `status` | string | No | Descope field status. |
| `client_id` | string | No | Descope field clientId. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |
| `registration_method` | string | No | Descope field registrationMethod. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search policy rules

**Slug:** `DESCOPE_SEARCH_POLICY_RULES`

Search policy rules. Search policy rule rows by filters (text, action_kind, effect, principal_type, resource_type, enabled). Paged and sorted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Descope field page. |
| `sort` | array | No | Descope field sort. |
| `text` | string | No | Descope field text. |
| `effect` | array | No | Descope field effect. |
| `enabled` | boolean | No | Descope field enabled. |
| `batch_size` | integer | No | Descope field batchSize. |
| `action_kind` | array | No | Descope field actionKind. |
| `rule_family` | array | No | Descope field ruleFamily. |
| `resource_type` | array | No | Descope field resourceType. |
| `search_fields` | array | No | Descope field searchFields. |
| `principal_type` | array | No | Descope field principalType. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Roles

**Slug:** `DESCOPE_SEARCH_ROLES`

Search Roles. ### Search roles, using a valid management key. This API endpoint allows administrators to search against existing roles. This endpoint returns an array of roles including their name, description, and permissionsNames that match the search parameters. ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Descope field sort. |
| `text` | string | No | Full text search across relevant columns |
| `role_ids` | array | No | Descope field roleIds. |
| `role_names` | array | No | Descope field roleNames. |
| `tenant_ids` | array | No | Descope field tenantIds. |
| `role_name_like` | string | No | Descope field roleNameLike. |
| `permission_names` | array | No | Descope field permissionNames. |
| `include_project_roles` | boolean | No | relevant when tenantIds are set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Tenants

**Slug:** `DESCOPE_SEARCH_TENANTS`

List or filter project tenants by IDs, names, domains, attributes, authentication type, or hierarchy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auth_type` | string | No | Match the provider authentication type. |
| `tenant_ids` | array | No | Match any of these tenant IDs. |
| `sso_domains` | array | No | Match tenant SSO domains. |
| `tenant_names` | array | No | Match any of these tenant names. |
| `top_level_only` | boolean | No | Return only top-level tenants. |
| `parent_tenant_id` | string | No | Return direct children of this parent tenant ID. |
| `custom_attributes` | object | No | Match configured tenant custom attributes by key and value. |
| `self_provisioning_domains` | array | No | Match tenant self-provisioning domains. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search test Users

**Slug:** `DESCOPE_SEARCH_TEST_USERS`

Search test Users. Search test users, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number starting with 0 for the first page |
| `scim` | boolean | No | Descope field scim. |
| `sort` | array | No | Descope field sort. |
| `text` | string | No | Full text search across relevant columns |
| `totp` | boolean | No | Descope field totp. |
| `limit` | integer | No | Default is 100 if not specified |
| `emails` | array | No | Descope field emails. |
| `offset` | integer | No | Direct row offset for pagination (0-based). When set to a positive value, this takes precedence over the page-based offset (page * limit). |
| `phones` | array | No | Descope field phones. |
| `login_id` | string | No | Search for specific login ID |
| `password` | boolean | No | Descope field password. |
| `sso_only` | boolean | No | Bring only users that have SSO external IDs |
| `statuses` | array | No | If not empty then users must be in one of those statuses |
| `user_ids` | array | No | Descope field userIds. |
| `webauthn` | boolean | No | Descope field webauthn. |
| `dependent` | boolean | No | If provided, filter users by whether they are a dependent user (i.e. a user that is linked to a family and does not have their own login credentials) |
| `login_ids` | array | No | Descope field loginIds. |
| `scim_only` | boolean | No | Bring only users that provisioned or updated by SCIM |
| `family_ids` | array | No | If not empty then users must be members of at least one of these families |
| `role_names` | array | No | If not empty then users must have one of the specified roles |
| `tenant_ids` | array | No | If not empty then users must be members of at least one of these tenants |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |
| `lock_reasons` | array | No | If not empty then only users that were disabled by brute-force protection with one of the given lock reasons |
| `verified_email` | boolean | No | If provided, filter users by whether their email is verified |
| `verified_phone` | boolean | No | If provided, filter users by whether their phone is verified |
| `with_test_user` | boolean | No | Return also users which are test users |
| `recovery_emails` | array | No | If not empty then users must have one of the specified recovery emails (exact match) |
| `recovery_phones` | array | No | If not empty then users must have one of the specified recovery phones (exact match) |
| `tenant_role_ids` | object | No | Descope field tenantRoleIds. |
| `test_users_only` | boolean | No | Return only test users |
| `to_created_time` | string | No | Upper bound on user creation time, inclusive. Unix timestamp in milliseconds, sent as a string (e.g. "1746057600000"). |
| `selected_columns` | array | No | Descope field selectedColumns. |
| `to_modified_time` | string | No | Upper bound on user modification time, inclusive. Unix timestamp in milliseconds, sent as a string. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `from_created_time` | string | No | Lower bound on user creation time, inclusive. Unix timestamp in milliseconds, sent as a string (e.g. "1743465600000"). |
| `temp_lock_reasons` | array | No | If not empty then only users that are currently temporarily locked by brute-force protection with one of the given lock reasons (TOTP has no temporary lock) |
| `tenant_role_names` | object | No | Descope field tenantRoleNames. |
| `from_modified_time` | string | No | Lower bound on user modification time, inclusive. Unix timestamp in milliseconds, sent as a string. |
| `to_last_login_time` | string | No | Upper bound on the user's last authentication time, inclusive. Unix timestamp in milliseconds, sent as a string. Users that never authenticated are excluded. |
| `include_sub_tenants` | boolean | No | Descope field includeSubTenants. |
| `from_last_login_time` | string | No | Lower bound on the user's last authentication time, inclusive. Unix timestamp in milliseconds, sent as a string (e.g. "1743465600000"). Users that never authenticated are excluded. |
| `verified_recovery_email` | boolean | No | If provided, filter users by whether their recovery email is verified |
| `verified_recovery_phone` | boolean | No | If provided, filter users by whether their recovery phone is verified |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search third party application consents

**Slug:** `DESCOPE_SEARCH_THIRD_PARTY_APPLICATION_CONSENTS`

Search third party application consents. Search OAuth user consents for [Inbound Apps](/identity-federation/inbound-apps). Filter by `appId`, `userId`, `consentId`, or `tenantId`. For [agentic identities](/agentic-identity-hub/core-components/agents) (MCP server authorizations), use [Search agentic identities](/api/management/agentic-identity-hub/search-agentic-identities) instead — it returns agent name, resource ID, and client ID alongside each consent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number starting with 0 for the first page |
| `limit` | integer | No | Descope field limit. |
| `app_id` | string | No | Descope field appId. |
| `user_id` | string | No | Descope field userId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `consent_id` | string | No | Descope field consentId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Users

**Slug:** `DESCOPE_SEARCH_USERS`

Search project users with identity, tenant, role, status, authentication-state, and time filters; returns one offset-controlled page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Zero-based page number; ignored for positioning when a positive offset is supplied. |
| `scim` | boolean | No | Filter by SCIM state. |
| `sort` | array | No | Sort fields, each with a supported field and descending flag. |
| `text` | string | No | Full-text search across relevant user fields. |
| `totp` | boolean | No | Filter by whether TOTP is configured. |
| `limit` | integer | No | Maximum users to return; Descope defaults to 100. |
| `emails` | array | No | Match any of these exact email addresses. |
| `offset` | integer | No | Zero-based direct row offset; positive values override page-based positioning. |
| `phones` | array | No | Match any of these exact phone numbers. |
| `login_id` | string | No | Return users matching this specific login ID. |
| `password` | boolean | No | Filter by whether password authentication is configured. |
| `sso_only` | boolean | No | Return only users with SSO external IDs. |
| `statuses` | array | No | Return users with status invited, enabled, disabled, or expired. |
| `user_ids` | array | No | Match any of these Descope user IDs. |
| `webauthn` | boolean | No | Filter by whether WebAuthn is configured. |
| `dependent` | boolean | No | Filter by whether the user is a dependent family user. |
| `login_ids` | array | No | Match any of these exact login IDs. |
| `scim_only` | boolean | No | Return only users provisioned or updated by SCIM. |
| `family_ids` | array | No | Return users belonging to at least one of these family IDs. |
| `role_names` | array | No | Return users having at least one of these role names. |
| `tenant_ids` | array | No | Return users belonging to at least one of these tenant IDs. |
| `sso_app_ids` | array | No | Match users assigned to any of these SSO application IDs. |
| `lock_reasons` | array | No | Filter users disabled for password, TOTP, recovery-code, or security-question brute-force locks. |
| `verified_email` | boolean | No | Filter by whether the primary email is verified. |
| `verified_phone` | boolean | No | Filter by whether the primary phone is verified. |
| `with_test_user` | boolean | No | Include test users in results. |
| `recovery_emails` | array | No | Match any of these exact recovery emails. |
| `recovery_phones` | array | No | Match any of these exact recovery phones. |
| `tenant_role_ids` | object | No | Map tenant IDs to {values: role IDs, and: boolean} filters. |
| `test_users_only` | boolean | No | Return only test users. |
| `to_created_time` | string | No | Inclusive upper creation-time bound as Unix milliseconds encoded as a string. |
| `selected_columns` | array | No | Limit response population to these provider column names. |
| `to_modified_time` | string | No | Inclusive upper modification-time bound as Unix milliseconds encoded as a string. |
| `custom_attributes` | object | No | Match configured user custom attributes by key and value. |
| `from_created_time` | string | No | Inclusive lower creation-time bound as Unix milliseconds encoded as a string. |
| `temp_lock_reasons` | array | No | Filter users temporarily locked for password, recovery-code, or security-question failures. |
| `tenant_role_names` | object | No | Map tenant IDs to {values: role names, and: boolean} filters. |
| `from_modified_time` | string | No | Inclusive lower modification-time bound as Unix milliseconds encoded as a string. |
| `to_last_login_time` | string | No | Inclusive upper last-login bound as Unix milliseconds encoded as a string; excludes users who never authenticated. |
| `include_sub_tenants` | boolean | No | Include users in descendant tenants. |
| `from_last_login_time` | string | No | Inclusive lower last-login bound as Unix milliseconds encoded as a string; excludes users who never authenticated. |
| `verified_recovery_email` | boolean | No | Filter by whether the recovery email is verified. |
| `verified_recovery_phone` | boolean | No | Filter by whether the recovery phone is verified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send SSO Admin Link

**Slug:** `DESCOPE_SEND_TENANT_ADMIN_LINK_SSO`

Send SSO Admin Link. ### Send an SSO admin link to a tenant administrator, using a valid management key. This API endpoint sends an SSO admin link via email to the specified tenant administrator. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Descope field email. |
| `sso_id` | string | No | Descope field ssoId. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set access key attribute

**Slug:** `DESCOPE_SET_ACCESS_KEY_ATTRIBUTE`

Set access key attribute. Create or update a single access key custom attribute definition (upsert by machine name), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `type` | string | Yes | Descope field type. |
| `options` | string | No | JSON arrays of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |
| `display_name` | string | Yes | Descope field displayName. |
| `edit_permissions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `view_permissions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set admin portal settings

**Slug:** `DESCOPE_SET_ADMIN_PORTAL_SETTINGS`

Set admin portal settings. Update the project's admin portal settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `widgets` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `style_id` | string | No | Descope field styleId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set auth access policy settings

**Slug:** `DESCOPE_SET_AUTH_ACCESS_SETTINGS`

Set auth access policy settings. Update the project-level auth access policy settings. ruleIds sets the full evaluation order and must list every rule exactly once. Fields that are not sent keep their stored values, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_ids` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `default_action` | string | No | Descope field defaultAction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set embedded link settings

**Slug:** `DESCOPE_SET_EMBEDDED_LINK_SETTINGS`

Set embedded link settings. Set the project's embedded link settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `expiration_time` | integer | No | Descope field expirationTime. |
| `expiration_time_unit` | string | No | Descope field expirationTimeUnit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set enchanted link settings

**Slug:** `DESCOPE_SET_ENCHANTED_LINK_SETTINGS`

Set enchanted link settings. Set the project's enchanted link settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `redirect_url` | string | No | Descope field redirectUrl. |
| `expiration_time` | integer | No | Descope field expirationTime. |
| `text_template_id` | string | No | Descope field textTemplateId. |
| `email_template_id` | string | No | Active template selection by id. Absent = keep the current selection; "" = reset to the built-in System template; a template id = select that stored template. |
| `text_connector_id` | string | No | Descope field textConnectorId. |
| `email_connector_id` | string | No | Descope field emailConnectorId. |
| `expiration_time_unit` | string | No | Descope field expirationTimeUnit. |
| `external_email_template_id` | string | No | Descope field externalEmailTemplateId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Family Settings

**Slug:** `DESCOPE_SET_FAMILY_SETTINGS`

Set Family Settings. Set the project's family account settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `max_family_members` | integer | No | Descope field maxFamilyMembers. |
| `allow_multiple_families_users` | boolean | No | Descope field allowMultipleFamiliesUsers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set flow

**Slug:** `DESCOPE_SET_FLOW`

Set flow. Create or update a single flow from its exported representation, remapping any connector and role references to matching entities in the project, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Descope field flowId. |
| `screens` | array | No | Descope field screens. |
| `contents` | object | Yes | Descope field contents. |
| `metadata` | object | Yes | Used by managementservice snapshots - make sure not to break compatibility |
| `references` | object | No | Used by managementservice snapshots - make sure not to break compatibility |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update governance settings

**Slug:** `DESCOPE_SET_GOVERNANCE_SETTINGS`

Update governance settings. Update the project's Agentic Governance Suite settings, using a valid management key. Only the fields present in the request are changed. Requires the Agentic Governance Suite in the company license, except a request that changes nothing, which succeeds without it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `configured` | boolean | No | Whether the Agentic Governance Suite has been activated for the project. |
| `auto_approval` | boolean | No | When true, a new access request that the current policies already permit (every requested target is covered by an enabled policy) is approved and its agent client provisioned at creation. |
| `suite_disabled` | boolean | No | When true, the suite is switched off: no new access requests can be created and none are auto-approved. Existing requests can still be searched, loaded and resolved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set magic link settings

**Slug:** `DESCOPE_SET_MAGIC_LINK_SETTINGS`

Set magic link settings. Set the project's magic link settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `redirect_url` | string | No | Descope field redirectUrl. |
| `expiration_time` | integer | No | Descope field expirationTime. |
| `text_template_id` | string | No | Descope field textTemplateId. |
| `email_template_id` | string | No | Active template selection by id. Absent = keep the current selection; "" = reset to the built-in System template; a template id = select that stored template. |
| `text_connector_id` | string | No | Descope field textConnectorId. |
| `email_connector_id` | string | No | Descope field emailConnectorId. |
| `expiration_time_unit` | string | No | Descope field expirationTimeUnit. |
| `external_email_template_id` | string | No | Descope field externalEmailTemplateId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set OAuth provider

**Slug:** `DESCOPE_SET_OAUTH_PROVIDER`

Set OAuth provider. Create or update a single OAuth provider, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `issuer` | string | No | Descope field issuer. |
| `scopes` | string | No | JSON arrays of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |
| `enabled` | boolean | No | Descope field enabled. |
| `prompts` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `auth_url` | string | No | Descope field authUrl. |
| `jwks_url` | string | No | Descope field jwksUrl. |
| `client_id` | string | No | Descope field clientId. |
| `token_url` | string | No | Descope field tokenUrl. |
| `use_nonce` | boolean | No | Has no effect on the authorization code flow. Set strictOIDCValidation to send and verify a nonce. |
| `description` | string | No | Configuration fields for custom providers; Descope-managed and rejected on system provider writes |
| `redirect_url` | string | No | Descope field redirectUrl. |
| `client_secret` | string | No | Write-only. Read returns PLACEHOLDER_VALUE when set. PLACEHOLDER_VALUE=keep, ""=clear (rejected when required), value=set |
| `user_data_url` | string | No | Descope field userDataUrl. |
| `sign_algorithm` | string | No | Algorithm the provider signs its ID tokens with, verified against the keys at jwksUrl. Required when jwksUrl is set, so strictOIDCValidation needs it too. Descope-managed and rejected on system provider writes |
| `callback_domain` | string | No | Descope field callbackDomain. |
| `native_client_id` | string | No | Native (mobile) client credentials |
| `use_self_account` | boolean | No | Whether logins use the caller's own OAuth app credentials rather than Descope's shared app; always true for custom providers |
| `allowed_grant_types` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `apple_key_generator` | string | No | JSON objects with the AppleKeyGenerator fields (keyId, teamId, privateKey); Value makes empty and absent distinct: null/absent = keep, {} = clear, object = set. Only valid for the apple system provider. Validated in the service |
| `jit_updates_disabled` | boolean | No | Descope field jitUpdatesDisabled. |
| `native_client_secret` | string | No | Write-only. Read returns PLACEHOLDER_VALUE when set. PLACEHOLDER_VALUE=keep, ""=clear (rejected when required), value=set |
| `use_client_assertion` | boolean | No | Descope field useClientAssertion. |
| `strict_oidcvalidation` | boolean | No | Sends a nonce on the authorization code flow and requires it in the ID token, and rejects an ID token whose audience is not the client ID. Requires jwksUrl and issuer so the ID token is verified. Native and One Tap logins are not affected |
| `trust_provided_emails` | boolean | No | Descope field trustProvidedEmails. |
| `manage_provider_tokens` | boolean | No | Descope field manageProviderTokens. |
| `user_data_claims_mapping` | object | No | Replaced wholesale when present, left untouched when absent |
| `auth_url_additional_params` | string | No | JSON object of static string parameters added to the authorization request, such as {"acr_values": "AAL3_ANY"} for NHS CIS2 or {"vtr": "[\"P9.Cp.Cd\"]"} for NHS login. Value makes empty and absent distinct: null/absent = keep, {} = clear, object = replace. Validated in the service |
| `native_apple_key_generator` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `client_assertion_signing_alg` | string | No | Algorithm signing the private_key_jwt client assertion when useClientAssertion is set. RS256 (default when empty) or RS512; the IdP must be registered with the same algorithm |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set OAuth settings

**Slug:** `DESCOPE_SET_OAUTH_SETTINGS`

Set OAuth settings. Set the project's general OAuth settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set OTP settings

**Slug:** `DESCOPE_SET_OTPSETTINGS`

Set OTP settings. Set the project's one-time passcode settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | No | Descope field domain. |
| `enabled` | boolean | No | Descope field enabled. |
| `expiration_time` | integer | No | Descope field expirationTime. |
| `text_template_id` | string | No | Descope field textTemplateId. |
| `email_template_id` | string | No | Active template selection by id. Absent = keep the current selection; "" = reset to the built-in System template; a template id = select that stored template. |
| `text_connector_id` | string | No | Descope field textConnectorId. |
| `voice_template_id` | string | No | Descope field voiceTemplateId. |
| `email_connector_id` | string | No | Descope field emailConnectorId. |
| `voice_connector_id` | string | No | Descope field voiceConnectorId. |
| `expiration_time_unit` | string | No | Descope field expirationTimeUnit. |
| `external_email_template_id` | string | No | Descope field externalEmailTemplateId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable or disable an outbound SCIM configuration

**Slug:** `DESCOPE_SET_OUTBOUND_SCIMENABLED`

Enable or disable an outbound SCIM configuration. Enable or disable a specific outbound SCIM configuration. Separate from Update because enable/disable is a high-frequency toggle.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `enabled` | boolean | No | Descope field enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set passkey settings

**Slug:** `DESCOPE_SET_PASSKEY_SETTINGS`

Set passkey settings. Set the project's passkey (WebAuthn) settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `enabled` | boolean | No | Descope field enabled. |
| `relying_party_id` | string | No | Descope field relyingPartyId. |
| `android_fingerprints` | string | No | JSON array of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set password settings

**Slug:** `DESCOPE_SET_PASSWORD_SETTINGS_V2`

Set password settings. Set the project's password settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lock` | boolean | No | Descope field lock. |
| `reuse` | boolean | No | Descope field reuse. |
| `number` | boolean | No | Descope field number. |
| `enabled` | boolean | No | Descope field enabled. |
| `lowercase` | boolean | No | Descope field lowercase. |
| `temp_lock` | boolean | No | Descope field tempLock. |
| `uppercase` | boolean | No | Descope field uppercase. |
| `any_letter` | boolean | No | Descope field anyLetter. |
| `expiration` | boolean | No | Descope field expiration. |
| `mask_error` | boolean | No | Descope field maskError. |
| `min_length` | integer | No | Descope field minLength. |
| `reuse_amount` | integer | No | Descope field reuseAmount. |
| `lock_attempts` | integer | No | Descope field lockAttempts. |
| `role_policies` | string | No | Stricter complexity rules for users who hold specific roles, as a JSON array of policy objects. Each policy has a "roleNames" array with the names of project roles, and any of the complexity fields of these settings: "minLength", "lowercase", "uppercase", "number", "nonAlphanumeric", "anyLetter", "disallowedCharacters", "disallowEmailMatch", "enablePasswordStrength" and "passwordStrengthScore". For a user who holds any of the listed roles, at the project level or in one of their tenants, each rule is merged with these settings and the strictest value wins, so a policy can only make the password requirements stricter. The policies apply when a signed-in user sets or changes their own password. Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |
| `expiration_weeks` | integer | No | Descope field expirationWeeks. |
| `non_alphanumeric` | boolean | No | Descope field nonAlphanumeric. |
| `email_template_id` | string | No | Active template selection by id. Absent = keep the current selection; "" = reset to the built-in System template; a template id = select that stored template. Note that the same stored templates serve both the magic link and enchanted link reset flavors. |
| `email_connector_id` | string | No | Descope field emailConnectorId. |
| `temp_lock_attempts` | integer | No | Descope field tempLockAttempts. |
| `temp_lock_duration` | integer | No | Descope field tempLockDuration. |
| `disallow_email_match` | boolean | No | Descope field disallowEmailMatch. |
| `disallowed_characters` | string | No | Descope field disallowedCharacters. |
| `password_strength_score` | integer | No | Descope field passwordStrengthScore. |
| `enable_password_strength` | boolean | No | Descope field enablePasswordStrength. |
| `external_email_template_id` | string | No | Descope field externalEmailTemplateId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set project settings

**Slug:** `DESCOPE_SET_PROJECT_SETTINGS`

Set project settings. Update the project's settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_url` | string | No | Descope field appUrl. |
| `invite_url` | string | No | Descope field inviteUrl. |
| `rotate_jwt` | boolean | No | Descope field rotateJwt. |
| `custom_domain` | string | No | Descope field customDomain. |
| `inactivity_time` | integer | No | Descope field inactivityTime. |
| `invite_send_sms` | boolean | No | Descope field inviteSendSms. |
| `key_template_id` | string | No | Descope field keyTemplateId. |
| `test_user_regex` | string | No | Descope field testUserRegex. |
| `trusted_domains` | string | No | Descope field trustedDomains. |
| `user_template_id` | string | No | Descope field userTemplateId. |
| `enable_inactivity` | boolean | No | Descope field enableInactivity. |
| `invite_magic_link` | boolean | No | Descope field inviteMagicLink. |
| `invite_send_email` | boolean | No | Descope field inviteSendEmail. |
| `session_migration` | object | No | session migration, fully replaced when present (not patched field by field) |
| `apps_custom_domain` | string | No | The custom domain federated and inbound app URLs are built on: the hostname of customDomain or of one of the project's other custom domains. Empty means customDomain. |
| `default_no_ssoapps` | boolean | No | Descope field defaultNoSSOApps. |
| `invite_expire_user` | boolean | No | Descope field inviteExpireUser. |
| `disable_auth_hosting` | boolean | No | Descope field disableAuthHosting. |
| `inactivity_time_unit` | string | No | Descope field inactivityTimeUnit. |
| `trusted_proxy_secret` | string | No | Secret a trusted reverse proxy sends in the x-descope-proxy-secret header, so its forwarded host headers are honored. At least 64 visible ASCII characters, no spaces (e.g. the output of `openssl rand -base64 48`). Write-only: reads return PLACEHOLDER_VALUE when set, "" clears it. |
| `tenant_user_isolation` | boolean | No | Descope field tenantUserIsolation. |
| `invite_expiration_time` | integer | No | Descope field inviteExpirationTime. |
| `max_concurrent_sessions` | integer | No | Concurrent-session limit (NIST SP 800-53 AC-10). 0 means no limit. The upper bound is configured per deployment and enforced by projectservice, so it is deliberately not repeated here - a hardcoded ceiling would reject values the console accepts. Enforcement applies to sessions created after it is set; pre-existing sessions are untracked. |
| `stepup_token_expiration` | integer | No | Descope field stepupTokenExpiration. |
| `invite_email_template_id` | string | No | Active template selection by id. Absent = keep the current selection; "" = reset to the built-in System template; a template id = select that stored template. |
| `refresh_token_expiration` | integer | No | Descope field refreshTokenExpiration. |
| `session_token_expiration` | integer | No | Descope field sessionTokenExpiration. |
| `invite_email_connector_id` | string | No | Descope field inviteEmailConnectorId. |
| `project_self_provisioning` | boolean | No | Descope field projectSelfProvisioning. |
| `test_user_allow_fixed_auth` | boolean | No | Descope field testUserAllowFixedAuth. |
| `test_user_fixed_auth_token` | string | No | Descope field testUserFixedAuthToken. |
| `invite_expiration_time_unit` | string | No | Descope field inviteExpirationTimeUnit. |
| `refresh_token_cookie_domain` | string | No | Descope field refreshTokenCookieDomain. |
| `refresh_token_cookie_policy` | string | No | Descope field refreshTokenCookiePolicy. |
| `session_token_cookie_domain` | string | No | Descope field sessionTokenCookieDomain. |
| `session_token_cookie_policy` | string | No | Descope field sessionTokenCookiePolicy. |
| `key_session_token_expiration` | integer | No | Descope field keySessionTokenExpiration. |
| `stepup_token_expiration_unit` | string | No | Descope field stepupTokenExpirationUnit. |
| `refresh_token_expiration_unit` | string | No | Descope field refreshTokenExpirationUnit. |
| `refresh_token_response_method` | string | No | Descope field refreshTokenResponseMethod. |
| `session_token_expiration_unit` | string | No | Descope field sessionTokenExpirationUnit. |
| `session_token_response_method` | string | No | Descope field sessionTokenResponseMethod. |
| `trusted_device_token_expiration` | integer | No | Descope field trustedDeviceTokenExpiration. |
| `key_session_token_expiration_unit` | string | No | Descope field keySessionTokenExpirationUnit. |
| `allow_auth_hosting_iframe_embedding` | boolean | No | Descope field allowAuthHostingIframeEmbedding. |
| `test_user_fixed_auth_verifier_regex` | string | No | Descope field testUserFixedAuthVerifierRegex. |
| `trusted_device_token_expiration_unit` | string | No | Descope field trustedDeviceTokenExpirationUnit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Scope Claim Mapping

**Slug:** `DESCOPE_SET_SCOPE_CLAIM_MAPPING`

Set Scope Claim Mapping. Replace the project-wide mapping of OIDC scopes to JWT claims. Each value may be a static string or a {{...}} template resolved at token-generation time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mappings` | array | No | Ordered list of scope→claims entries replacing the project-wide mapping. Pass an empty list to clear the mapping; the dedicated DeleteScopeClaimMapping RPC is preferred when fully removing the singleton. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set session classification

**Slug:** `DESCOPE_SET_SESSION_CLASSIFICATION`

Set session classification. Create or update a session classification (upsert by name), using a valid management key. On a new name the defaults are applied; on an existing one, fields left out keep their stored value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `version` | integer | No | The revision this group was read at. Send it back on an update and the write is rejected with a conflict if someone else changed the group in the meantime. Omit it to update regardless of who wrote last. |
| `description` | string | No | Descope field description. |
| `created_time` | integer | No | Computed server side: accepted and ignored on write, so a read response can be sent back as an update. Epoch seconds as int32, matching every other createdTime/modifiedTime in this file: protobuf JSON renders a 64-bit integer as a quoted string. |
| `modified_time` | integer | No | Descope field modifiedTime. |
| `access_all_tenants` | boolean | No | Members may access every tenant in the project regardless of their explicit assignments |
| `max_concurrent_sessions` | integer | No | Overrides the project-wide limit for members, in both directions. 0 means UNLIMITED: it lifts the project cap for members rather than inheriting it. |
| `session_time_limit_rule` | string ("SESSION_TIME_LIMIT_RULE_UNSPECIFIED" | "SESSION_TIME_LIMIT_RULE_MIN_OF_TENANTS" | "SESSION_TIME_LIMIT_RULE_PROJECT_SETTINGS" | "SESSION_TIME_LIMIT_RULE_CURRENT_TENANT") | No | How a member's session time limit is decided. SESSION_TIME_LIMIT_RULE_UNSPECIFIED (0, the default) means the group does not override it, so members are treated like a user with no group at all. SESSION_TIME_LIMIT_RULE_MIN_OF_TENANTS (1) uses the shortest limit among all the tenants the user belongs to. SESSION_TIME_LIMIT_RULE_PROJECT_SETTINGS (2) inherits the project-wide session time limit. SESSION_TIME_LIMIT_RULE_CURRENT_TENANT (3) follows the limit of the tenant the session is currently in, so it changes with the tenant context rather than being fixed at sign-in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set SSO settings

**Slug:** `DESCOPE_SET_SSOSETTINGS`

Set SSO settings. Set the project's SSO settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `merge_users` | boolean | No | Descope field mergeUsers. |
| `redirect_url` | string | No | Descope field redirectUrl. |
| `email_template_id` | string | No | Active template selection by id. Absent = keep the current selection; "" = reset to the built-in System template; a template id = select that stored template. |
| `email_connector_id` | string | No | Descope field emailConnectorId. |
| `hide_sso_suite_sso` | boolean | No | Descope field hideSsoSuiteSso. |
| `show_sso_suite_xaa` | boolean | No | Descope field showSsoSuiteXaa. |
| `sso_suite_style_id` | string | No | Descope field ssoSuiteStyleId. |
| `hide_sso_suite_oidc` | boolean | No | Descope field hideSsoSuiteOidc. |
| `hide_sso_suite_saml` | boolean | No | Descope field hideSsoSuiteSaml. |
| `hide_sso_suite_scim` | boolean | No | Descope field hideSsoSuiteScim. |
| `allow_override_roles` | boolean | No | Descope field allowOverrideRoles. |
| `hide_sso_suite_audit` | boolean | No | Hides the audit log page of the SSO Setup Suite, which lists a tenant's recent SSO login and SCIM events for the SSO configuration being set up. Default false (the page is shown). A tenant with tenant-level suite settings uses its own ssoSetupSuiteSettings.disabledFeatures.audit instead. |
| `group_priority_enabled` | boolean | No | Descope field groupPriorityEnabled. |
| `hide_sso_suite_domains` | boolean | No | Descope field hideSsoSuiteDomains. |
| `sso_suite_login_flow_id` | string | No | Descope field ssoSuiteLoginFlowId. |
| `sso_suite_support_email` | string | No | Descope field ssoSuiteSupportEmail. |
| `hide_sso_suite_jit_guide` | boolean | No | Descope field hideSsoSuiteJitGuide. |
| `mark_email_as_unverified` | boolean | No | Descope field markEmailAsUnverified. |
| `mandatory_user_attributes` | string | No | JSON array of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |
| `external_email_template_id` | string | No | Descope field externalEmailTemplateId. |
| `hide_sso_suite_fga_mapping` | boolean | No | Descope field hideSsoSuiteFgaMapping. |
| `hide_sso_suite_role_mapping` | boolean | No | Descope field hideSsoSuiteRoleMapping. |
| `sso_suite_show_help_contact` | boolean | No | Descope field ssoSuiteShowHelpContact. |
| `hide_sso_suite_groups_mapping` | boolean | No | Descope field hideSsoSuiteGroupsMapping. |
| `sso_suite_login_flow_style_id` | string | No | Descope field ssoSuiteLoginFlowStyleId. |
| `block_if_email_domain_mismatch` | boolean | No | Descope field blockIfEmailDomainMismatch. |
| `sso_suite_force_domain_verification` | boolean | No | Descope field ssoSuiteForceDomainVerification. |
| `limit_mapping_to_mandatory_attributes` | boolean | No | Descope field limitMappingToMandatoryAttributes. |
| `oidc_login_id_mapping_default_override` | string | No | Descope field oidcLoginIdMappingDefaultOverride. |
| `allow_merge_users_with_multiple_tenants` | boolean | No | Descope field allowMergeUsersWithMultipleTenants. |
| `allow_duplicate_ssodomains_in_other_tenants` | boolean | No | Descope field allowDuplicateSSODomainsInOtherTenants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set tenant attribute

**Slug:** `DESCOPE_SET_TENANT_ATTRIBUTE`

Set tenant attribute. Create or update a single tenant custom attribute definition (upsert by machine name), using a valid management key. Tenant attributes do not support edit permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `type` | string | Yes | Descope field type. |
| `options` | string | No | JSON arrays of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |
| `display_name` | string | Yes | Descope field displayName. |
| `edit_permissions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `view_permissions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set tenant auth access policy settings

**Slug:** `DESCOPE_SET_TENANT_AUTH_ACCESS_SETTINGS`

Set tenant auth access policy settings. Update the tenant-level auth access policy settings. ruleIds sets the full evaluation order and must list every rule exactly once. Fields that are not sent keep their stored values, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_ids` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |
| `default_action` | string | No | Descope field defaultAction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set OTP Settings for a tenant

**Slug:** `DESCOPE_SET_TENANT_OTPSETTINGS`

Set OTP Settings for a tenant. Set OTP Settings for a tenant, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |
| `expiration_time` | integer | No | Descope field expirationTime. |
| `rate_limit_retries` | integer | No | Descope field rateLimitRetries. |
| `expiration_time_unit` | string | No | Descope field expirationTimeUnit. |
| `rate_limit_timeframe` | integer | No | Descope field rateLimitTimeframe. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Tenant Theme

**Slug:** `DESCOPE_SET_TENANT_THEME`

Set Tenant Theme. Create or replace the styles a tenant overrides the project theme with, using a valid management key. The styles document replaces the tenant's stored one whole, and the stored theme is returned. A logo must be given as a base64 data URI; it is published to this tenant's own CDN object and never overwrites the project's or another tenant's.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `styles` | object | Yes | The tenant's styles, in the same shape the project theme export and import use: an object keyed by style flavor, such as "light" and "dark" for the default style and "<styleId>-light" and "<styleId>-dark" for a named one. Every flavor must be an object. The document replaces the tenant's stored styles whole. A logo must be supplied as a base64 data URI, the same way the project theme import takes it. It is uploaded to this tenant's own CDN object, and a read hands it back as a data URI again, so a response can be sent back as a request unchanged. A logo given as a url is rejected, because a url points at an object this tenant does not own. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |
| `components_version` | string | No | Read-only: the flow-components bundle version the tenant's styles render against, resolved from the project. Accepted and ignored on write, so a response can be sent back unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set TOTP settings

**Slug:** `DESCOPE_SET_TOTPSETTINGS`

Set TOTP settings. Set the project's TOTP settings, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Descope field enabled. |
| `account_name_template` | string | No | Account name shown in the authenticator app, e.g. {{user.email}} or {{user.customAttributes.employeeId}}. Supports {{user.email}}, {{user.phone}}, {{user.name}}, {{user.loginId}}, {{user.customAttributes.<name>}}, {{tenant.name}} and {{tenant.id}}. When empty, or when it renders empty for a user, the login ID is used. |
| `issuer_label_template` | string | No | Issuer label shown in the authenticator app, e.g. {{projectName}} or {{tenant.name}}. Supports {{projectName}}, {{tenantName}}, {{tenant.name}} and {{tenant.id}}. When empty, the project name is used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Active Password for User

**Slug:** `DESCOPE_SET_USER_ACTIVE_PASSWORD`

Set Active Password for User. ### Set an active password for an existing user, using a valid management key. This API endpoint allows you to set an active password for an existing user. This will allow the user to authenticate with this password without changing it. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `password` | string | No | Descope field password. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set user attribute

**Slug:** `DESCOPE_SET_USER_ATTRIBUTE`

Set user attribute. Create or update a single user custom attribute definition (upsert by machine name), using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |
| `type` | string | Yes | Descope field type. |
| `options` | string | No | JSON arrays of strings; Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. Validated in the service |
| `display_name` | string | Yes | Descope field displayName. |
| `edit_permissions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `view_permissions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Temporary Password for User

**Slug:** `DESCOPE_SET_USER_TEMPORARY_PASSWORD`

Set Temporary Password for User. ### Set a temporary password for an existing user, using a valid management key. This API endpoint allows you to set a temporary password for an existing user. This will require the user to change their password on next authentication. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `password` | string | No | Descope field password. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update well-known settings

**Slug:** `DESCOPE_SET_WELL_KNOWN_SETTINGS`

Update well-known settings. Update the project's customization of its OIDC discovery documents, using a valid management key. Only the fields present in the request are changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Applies the customization to the served documents. Off by default: the customization is kept and the default documents are served. |
| `hidden_fields` | string | No | Array of field names to omit from the documents. Hideable fields: backchannel_authentication_endpoint, pushed_authorization_request_endpoint, request_parameter_supported, registration_endpoint, end_session_endpoint, introspection_endpoint, device_authorization_endpoint, revocation_endpoint, userinfo_endpoint, backchannel_logout_supported. |
| `removed_values` | string | No | Array of objects naming a list field and the values to remove from it, such as [{"field": "grant_types_supported", "values": ["client_credentials"]}]. Returned sorted by field. A list is never emptied: removing every value keeps the full list. |
| `claims_supported` | object | No | Claims added to or excluded from claims_supported. |
| `scopes_supported` | object | No | Scopes added to or excluded from scopes_supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set widget

**Slug:** `DESCOPE_SET_WIDGET`

Set widget. Create or update a single widget and its embedded flows from the exported representation, remapping any connector and role references to matching entities in the project, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flows` | array | No | Descope field flows. |
| `screens` | array | No | Descope field screens. |
| `metadata` | object | Yes | Descope field metadata. |
| `widget_id` | string | Yes | Descope field widgetId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SSO application custom attribute definitions

**Slug:** `DESCOPE_SSOAPPLICATION_CUSTOM_ATTRIBUTES`

Get SSO application custom attribute definitions. Get SSO application custom attribute definitions, using a valid management key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Family Impersonation

**Slug:** `DESCOPE_STOP_FAMILY_IMPERSONATION`

Stop Family Impersonation. Stop impersonating a family dependent and return to the acting admin's own session

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jwt` | string | Yes | Descope field jwt. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Impersonation

**Slug:** `DESCOPE_STOP_IMPERSONATION`

Stop Impersonation. Stop impersonation as a different user

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jwt` | string | Yes | Descope field jwt. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `selected_tenant` | string | No | Descope field selectedTenant. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load a list of defined relations for the given list of targets

**Slug:** `DESCOPE_TARGETS_RELATIONS`

Load a list of defined relations for the given list of targets. Load a list of defined relations for the given list of targets without recursively traversing the relation tree.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `targets` | array | No | Descope field targets. |
| `include_target_set_relations` | boolean | No | Descope field includeTargetSetRelations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Access Key

**Slug:** `DESCOPE_UPDATE_ACCESS_KEY`

Update Access Key. ### Update an existing access key, using a valid management key. This API endpoint allows administrators to update an existing access key. With this endpoint, you can only update the access key's name. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `role_names` | string | No | we want to differentiate between empty and nil so we use google.protobuf.Value |
| `description` | string | No | Descope field description. |
| `key_tenants` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `permitted_ips` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update auth access policy rule

**Slug:** `DESCOPE_UPDATE_AUTH_ACCESS_RULE`

Update auth access policy rule. Update a project-level auth access policy rule. Fields that are not sent keep their stored values, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Server-generated, rejected on create and required on update. |
| `name` | string | No | Descope field name. |
| `effect` | string | No | Required on create. Evaluation is first-match. |
| `enabled` | boolean | No | Defaults to true on create. |
| `conditions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `description` | string | No | Descope field description. |
| `expire_time` | integer | No | Epoch seconds after which the rule is no longer evaluated. 0 means never. |
| `created_time` | integer | No | int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md. |
| `modified_time` | integer | No | Descope field modifiedTime. |
| `evaluation_order` | integer | No | 1-based position in the evaluation order, set through the reorder and settings endpoints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update connector

**Slug:** `DESCOPE_UPDATE_CONNECTOR`

Update connector. Update a single connector, using a valid management key. This is a full replace, not a patch: get the connector first with GetConnector and send every field back with your changes, including `name`, `description` and the full `configuration`. Send `PLACEHOLDER_VALUE` to keep a stored secret; an omitted key is cleared, or reset to its default when it has one, and omitting a required secret fails validation. The `type` cannot change. The configuration is checked and filled as on create, except for messaging providers (ids starting with `MP`).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | The connector id, assigned by the server on create and required on update. |
| `name` | string | Yes | The connector's display name. |
| `type` | string | Yes | The connector template id, such as `http`, which cannot change after create. LoadAllConnectorTemplates lists the available templates. |
| `status` | string | No | Either `enabled` or `disabled`, defaults to `enabled` on create. A disabled connector is not run by flows or automatic triggers; audit streaming ignores `status` and follows the template's `auditEnabled` configuration field if it has one, and is otherwise always on. While its secrets are placeholders, create a connector `disabled`, also set `auditEnabled: false` on an audit connector whose template has that field, and enable it once the real values are in. |
| `description` | string | No | A free text description of the connector. |
| `configuration` | object | No | The template's configuration fields by name, as GetConnectorTemplate describes them. Checked against the template on create and update, with missing defaults filled in; not checked for messaging providers, which have no template. Secret values are returned as `PLACEHOLDER_VALUE`, and sending that value back keeps the stored secret. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Descoper

**Slug:** `DESCOPE_UPDATE_DESCOPER`

Update Descoper. Update a descoper

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `rbac` | object | No | Descope field rbac. |
| `attributes` | object | No | updateable fields (optional! updating attributes has additional constraints) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update dynamic registration template

**Slug:** `DESCOPE_UPDATE_DYNAMIC_REGISTRATION_TEMPLATE`

Update dynamic registration template. Update an existing dynamic registration template, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | object | Yes | DynamicRegistrationTemplate CRUD messages |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update engine

**Slug:** `DESCOPE_UPDATE_ENGINE`

Update engine. Update an existing engine, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | Yes | Descope field name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Family

**Slug:** `DESCOPE_UPDATE_FAMILY`

Update Family. Update a family's name, custom attributes, photo, or disabled state, using a valid management key. Omitted fields are left unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | No | Descope field name. |
| `photo` | string | No | Descope field photo. |
| `disabled` | boolean | No | Descope field disabled. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update JWT

**Slug:** `DESCOPE_UPDATE_JWT`

Update JWT. ### Updates a JWT with custom claims, using a valid management key. This API endpoint will update a JWT with custom claims. This endpoint takes the JWT as well as the `customClaims` json.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jwt` | string | Yes | Descope field jwt. |
| `custom_claims` | object | No | Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. |
| `refresh_duration` | integer | No | Descope field refreshDuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update JWT Template

**Slug:** `DESCOPE_UPDATE_JWT_TEMPLATE`

Update JWT Template. Update an existing JWT template by id. Same strict validation as CreateJwtTemplate runs first; on failure the existing template is unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | object | Yes | Descope field template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List

**Slug:** `DESCOPE_UPDATE_LIST`

Update List. Update an existing list

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `data` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `name` | string | No | Descope field name. |
| `type` | string | No | Descope field type. |
| `description` | string | No | Descope field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Management Key

**Slug:** `DESCOPE_UPDATE_MANAGEMENT_KEY`

Update Management Key. Update a management key using another management key. All supported fields will be reset if not provided, except reBac, which keeps the key's current roles when omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `re_bac` | object | No | Replaces the key's roles without rotating its secret. Unlike the other fields, leaving it unset keeps the current roles. The calling key's permission to manage management keys lets it grant any role, company full access included, but a key cannot change its own roles. |
| `status` | string | Yes | Descope field status. |
| `description` | string | Yes | Descope field description. |
| `permitted_ips` | array | No | Descope field permittedIps. |
| `trusted_issuer` | object | No | Descope field trustedIssuer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update MCP Server Client

**Slug:** `DESCOPE_UPDATE_MCP_SERVER_CLIENT`

Update MCP Server Client. Update an MCP Server Client, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | No | Descope field name. |
| `tags` | array | No | Descope field tags. |
| `scopes` | array | No | Descope field scopes. |
| `mcp_server_id` | string | Yes | Descope field mcpServerId. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update template

**Slug:** `DESCOPE_UPDATE_MESSAGING_TEMPLATE`

Update template. Update a single message template by type, method and id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `body` | string | No | Descope field body. |
| `name` | string | Yes | Descope field name. |
| `type` | string | Yes | Descope field type. |
| `method` | string | Yes | Descope field method. |
| `subject` | string | No | The fields below apply to email templates only: requests that carry them for other template types are rejected, and responses omit them. Like the fields above they're written as given on updates, so an omitted field is cleared rather than preserved. |
| `body_plain_text` | string | No | Descope field bodyPlainText. |
| `use_body_plain_text` | boolean | No | Descope field useBodyPlainText. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Outbound App

**Slug:** `DESCOPE_UPDATE_OUTBOUND_APP`

Update Outbound App. ### Update outbound application This endpoint allows you to update an existing outbound application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app` | object | Yes | Descope field app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update outbound SCIM configuration

**Slug:** `DESCOPE_UPDATE_OUTBOUND_SCIMCONFIGURATION`

Update outbound SCIM configuration. Update an existing outbound SCIM configuration, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `version` | string | No | Descope field version. |
| `configuration` | object | No | Descope field configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Permission

**Slug:** `DESCOPE_UPDATE_PERMISSION`

Update Permission. ### Update a permission, using a valid management key. This API endpoint allows administrators to update an existing permission. The endpoint takes the following two parameters: - name (required) - description (optional - though if not provided, it will be removed from the permission) ### Next Steps Once you have this data, you can utilize the newly created role to [Create Roles](/api/management/roles/create-role) or [Update Roles](/api/management/roles/update-role) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `name` | string | No | Either name or id must be provided (not both). The identified permission will be updated. |
| `new_name` | string | Yes | Descope field newName. |
| `description` | string | No | Descope field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Permissions

**Slug:** `DESCOPE_UPDATE_PERMISSIONS`

Bulk Update Permissions. Bulk update Permissions, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `permissions` | array | No | Descope field permissions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update policy rule

**Slug:** `DESCOPE_UPDATE_POLICY_RULE`

Update policy rule. Replace an existing policy rule row matched by id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policy_rule` | object | No | Descope field policyRule. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update policy rule settings

**Slug:** `DESCOPE_UPDATE_POLICY_RULE_SETTINGS`

Update policy rule settings. Update the project-level policy rule settings. defaultAction is allow or block; the choice is one-way and cannot be reset to the unconfigured state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `settings` | object | Yes | defaultAction decides the verdict when rules target the resource but none matches. An unconfigured project reports the empty value; updates must pick allow or block — the choice is one-way and cannot return to unset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `DESCOPE_UPDATE_PROJECT`

Update Project. Update the project's name, environment or tags, leaving any fields that aren't set in the request unchanged, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `tags` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `environment` | string | No | Descope field environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Project

**Slug:** `DESCOPE_UPDATE_PROJECT_NAME`

Rename Project. ### Rename a project utilizing a management key. This endpoint allows you to update the name of a project. The body only requires the `name` argument. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descope field name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project Tags

**Slug:** `DESCOPE_UPDATE_PROJECT_TAGS`

Update Project Tags. ### Update project tags utilizing a management key. This endpoint allows you to update the tags associated with a project. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Descope field tags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update resource

**Slug:** `DESCOPE_UPDATE_RESOURCE`

Update resource. Update a resource, using a valid management key. The request replaces the whole resource: load it, change the fields, and send it back with its version unchanged. The type and uri cannot be changed. A stale version fails with Resource not found (E074805), so reload the resource and retry. On a resource managed by an agent gateway (tagged gateway), the connection scopes come from the gateway routes and only their optional flag can be changed. On an MCP server (type mcp), dynamicRegistrationSettings.issuerType and dynamicRegistrationSettings.overrideProjectSettings keep their stored values when omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource` | object | Yes | Resource CRUD messages |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Role

**Slug:** `DESCOPE_UPDATE_ROLE`

Replace one role identified by name or ID. Send its complete new name, description, permission list, default flag, and private flag because Descope clears omitted replacement values. An empty permission_names list removes all permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Current role name. Provide exactly one of name or role_id. |
| `default` | boolean | Yes | Complete replacement default-role flag. |
| `private` | boolean | Yes | Complete replacement private-role flag. |
| `role_id` | string | No | Current role ID. Provide exactly one of role_id or name. |
| `new_name` | string | Yes | New role name. |
| `tenant_id` | string | No | Tenant ID for a tenant-scoped role. |
| `description` | string | Yes | Complete replacement role description; use an empty string to clear it. |
| `permission_names` | array | Yes | Complete replacement permission-name list; an empty list removes all permissions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Roles

**Slug:** `DESCOPE_UPDATE_ROLES`

Bulk Update Roles. Bulk update Roles, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | No | Descope field roles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SSO application permission

**Slug:** `DESCOPE_UPDATE_SSOAPPLICATION_PERMISSION`

Update SSO application permission. Update an SSO application permission by application id and permission id, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `app_id` | string | Yes | Descope field appId. |
| `description` | string | No | Descope field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SSO application role

**Slug:** `DESCOPE_UPDATE_SSOAPPLICATION_ROLE`

Update SSO application role. Update an SSO application role by application id and role id, using a valid management key. The full role is replaced with the given values, including permissionIds and roleMappings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `name` | string | Yes | Descope field name. |
| `app_id` | string | Yes | Descope field appId. |
| `description` | string | No | Descope field description. |
| `role_mappings` | array | No | Descope field roleMappings. |
| `permission_ids` | array | No | Descope field permissionIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update OIDC Application

**Slug:** `DESCOPE_UPDATE_SSOOIDCAPPLICATION`

Update OIDC Application. ### Update OIDC Application within a project This endpoint updates an OIDC Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `claims` | array | No | Descope field claims. |
| `enabled` | boolean | No | Descope field enabled. |
| `client_id` | string | No | Optional: import an existing OIDC client. Both are accepted on create only (immutable afterward); empty means the client_id is computed and the client_secret is generated server-side. The client_id must be unique within the project. The client_secret is returned once on the create response. |
| `dark_logo` | string | No | Descope field darkLogo. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | How the app authenticates as an OAuth client. 'confidential': a dedicated client ID and client secret, for server-side apps. 'public': a dedicated client ID and PKCE with no secret, for native, mobile and single-page apps. These apps normally use the project-level issuer and discovery endpoints. On create, an empty clientType means the legacy Access Key type (the project ID is the client ID, and the issuer and discovery endpoints are per app); accounts that can't use the legacy type get 'confidential' instead. On update, an empty clientType keeps the app's current type. |
| `description` | string | No | Descope field description. |
| `client_secret` | string | No | Descope field clientSecret. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `trusted_app_ids` | array | No | trustedAppIds lists sibling SSO apps whose roles are included in this app's JWT under the `trustedApps` claim at login time. Apps where the user has no roles are silently omitted. |
| `default_audience` | string | No | Default audience policy for issued tokens. Applies only to modern apps (non-empty clientType): 'projectId', 'clientId', 'appId', empty (both), or 'empty' (no aud at all). Legacy apps are unaffected. Mirrors third-party apps. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `assigned_role_ids` | array | No | assignedRoleIds lists project-level roles that grant access to this application. A user holding any of them can access it, in addition to users assigned directly or through their tenant. Additive: it never removes access, so it only changes the outcome for projects that deny applications by default. Tenant scoped roles are rejected. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `jwt_bearer_disabled` | boolean | No | Descope field jwtBearerDisabled. |
| `jwt_bearer_settings` | object | No | Descope field jwtBearerSettings. |
| `device_code_disabled` | boolean | No | Descope field deviceCodeDisabled. |
| `force_authentication` | boolean | No | Descope field forceAuthentication. |
| `service_account_roles` | array | No | serviceAccountRoles assigns this app (when client_credentials is enabled) application-roles in its trusted apps; surfaced in its client_credentials token under the `app.trustedApps` claim. |
| `trusted_apps_audience` | string | No | Audience policy applied to trusted sibling apps' identifiers when appended to the issued token's `aud` (see trustedAppIds). Same value set as defaultAudience: 'projectId' / 'clientId' / 'appId' / empty (=both) / 'empty' (add none). Independent of defaultAudience. |
| `approved_redirect_urls` | array | No | Descope field approvedRedirectUrls. |
| `refresh_token_disabled` | boolean | No | Descope field refreshTokenDisabled. |
| `back_channel_logout_url` | string | No | Descope field backChannelLogoutUrl. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `well_known_customization` | object | No | Descope field wellKnownCustomization. |
| `authorization_code_disabled` | boolean | No | Descope field authorizationCodeDisabled. |
| `client_credentials_disabled` | boolean | No | Descope field clientCredentialsDisabled. |
| `custom_idp_initiated_login_page_url` | string | No | Descope field customIdpInitiatedLoginPageUrl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SSO Provider IDs

**Slug:** `DESCOPE_UPDATE_SSOPROVIDER_IDS`

Update SSO Provider IDs. Update SSO provider IDs and SCIM provider IDs for tenant SSO settings. This endpoint is not publicly documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sso_id` | string | No | Descope field ssoId. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `xaa_provider_id` | string | No | Descope field xaaProviderId. |
| `oidc_provider_id` | string | No | Descope field oidcProviderId. |
| `saml_provider_id` | string | No | Descope field samlProviderId. |
| `oidc_scim_provider_id` | string | No | Descope field oidcScimProviderId. |
| `saml_scim_provider_id` | string | No | Descope field samlScimProviderId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SAML Application

**Slug:** `DESCOPE_UPDATE_SSOSAMLAPPLICATION`

Update SAML Application. ### Update SAML Application within a project This endpoint updates a SAML Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `acs_url` | string | No | Descope field acsUrl. |
| `enabled` | boolean | No | Descope field enabled. |
| `dark_logo` | string | No | Descope field darkLogo. |
| `entity_id` | string | No | Descope field entityId. |
| `certificate` | string | No | Descope field certificate. |
| `description` | string | No | Descope field description. |
| `metadata_url` | string | No | Descope field metadataUrl. |
| `groups_mapping` | array | No | Descope field groupsMapping. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `assigned_role_ids` | array | No | assignedRoleIds lists project-level roles that grant access to this application. A user holding any of them can access it, in addition to users assigned directly or through their tenant. Additive: it never removes access, so it only changes the outcome for projects that deny applications by default. Tenant scoped roles are rejected. |
| `attribute_mapping` | array | No | Descope field attributeMapping. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `use_metadata_info` | boolean | No | Descope field useMetadataInfo. |
| `error_redirect_url` | string | No | Descope field errorRedirectUrl. |
| `default_relay_state` | string | No | Descope field defaultRelayState. |
| `logout_redirect_url` | string | No | Descope field logoutRedirectUrl. |
| `force_authentication` | boolean | No | Descope field forceAuthentication. |
| `subject_name_id_type` | string | No | Descope field subjectNameIdType. |
| `acs_allowed_callbacks` | array | No | Descope field acsAllowedCallbacks. |
| `subject_name_id_format` | string | No | Descope field subjectNameIdFormat. |
| `default_signature_algorithm` | string | No | Descope field defaultSignatureAlgorithm. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SSO WS-Fed IDP application

**Slug:** `DESCOPE_UPDATE_SSOWSFED_APPLICATION`

Update SSO WS-Fed IDP application. Update a SSO WS-Fed IDP application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `realm` | string | No | Descope field realm. |
| `enabled` | boolean | No | Descope field enabled. |
| `dark_logo` | string | No | Descope field darkLogo. |
| `reply_url` | string | No | Descope field replyUrl. |
| `description` | string | No | Descope field description. |
| `groups_mapping` | array | No | Descope field groupsMapping. |
| `login_page_url` | string | No | Descope field loginPageUrl. |
| `assigned_role_ids` | array | No | assignedRoleIds lists project-level roles that grant access to this application. A user holding any of them can access it, in addition to users assigned directly or through their tenant. Additive: it never removes access, so it only changes the outcome for projects that deny applications by default. Tenant scoped roles are rejected. |
| `attribute_mapping` | array | No | Descope field attributeMapping. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `error_redirect_url` | string | No | Descope field errorRedirectUrl. |
| `logout_redirect_url` | string | No | Descope field logoutRedirectUrl. |
| `force_authentication` | boolean | No | Descope field forceAuthentication. |
| `reply_allowed_callbacks` | array | No | Descope field replyAllowedCallbacks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tenant

**Slug:** `DESCOPE_UPDATE_TENANT`

Patch selected fields of one tenant while leaving omitted fields unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New tenant name; omit to preserve it. |
| `disabled` | boolean | No | Set whether login to this tenant is disabled. |
| `auth_type` | string | No | Deprecated provider field; prefer tenant settings for auth type. |
| `tenant_id` | string | Yes | ID of the tenant to patch. |
| `enforce_sso` | boolean | No | Set whether this tenant requires SSO login. |
| `approved_domains` | array | No | Replacement vanity hostname list; Descope currently supports one item. |
| `role_inheritance` | string ("" | "none" | "userOnly") | No | New role inheritance behavior: an empty string, none, or userOnly. |
| `custom_attributes` | object | No | Replacement custom-attribute values; omit to preserve them. |
| `federated_app_ids` | array | No | Replacement federated application ID list; an empty list clears it. |
| `enforce_sso_exclusions` | array | No | Replacement user-ID exemptions from SSO enforcement; an empty list clears them. |
| `self_provisioning_domains` | array | No | Replacement self-provisioning domain list; omit to preserve it. |
| `enforce_sso_exclusion_permissions` | array | No | Replacement break-glass permission list; an empty list clears it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update tenant auth access policy rule

**Slug:** `DESCOPE_UPDATE_TENANT_AUTH_ACCESS_RULE`

Update tenant auth access policy rule. Update a tenant-level auth access policy rule. Fields that are not sent keep their stored values, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Server-generated, rejected on create and required on update. |
| `name` | string | No | Descope field name. |
| `effect` | string | No | Required on create. Evaluation is first-match. |
| `enabled` | boolean | No | Defaults to true on create. |
| `tenant_id` | string | Yes | Descope tenantId parameter. |
| `conditions` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |
| `description` | string | No | Descope field description. |
| `expire_time` | integer | No | Epoch seconds after which the rule is no longer evaluated. 0 means never. |
| `created_time` | integer | No | int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md. |
| `modified_time` | integer | No | Descope field modifiedTime. |
| `evaluation_order` | integer | No | 1-based position in the evaluation order, set through the reorder and settings endpoints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tenant Default Roles

**Slug:** `DESCOPE_UPDATE_TENANT_DEFAULT_ROLES`

Update Tenant Default Roles. Update tenant default roles, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `default_roles` | array | No | Descope field defaultRoles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tenants Batch

**Slug:** `DESCOPE_UPDATE_TENANTS_BATCH`

Update Tenants Batch. 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenants` | array | Yes | Descope field tenants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update third party application

**Slug:** `DESCOPE_UPDATE_THIRD_PARTY_APPLICATION`

Update third party application. Update a third party application, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `logo_url` | string | No | Descope field logoUrl. |
| `force_par` | boolean | No | Descope field forcePar. |
| `force_dpop` | boolean | No | Descope field forceDpop. |
| `force_mtls` | boolean | No | Descope field forceMtls. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | Descope field clientType. |
| `description` | string | No | Descope field description. |
| `ciba_enabled` | boolean | No | cibaEnabled allows the CIBA grant (urn:openid:params:grant-type:ciba) for this app and requires cibaSettings. Default false. A public client cannot use this grant. |
| `jar_settings` | object | No | JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications |
| `rar_settings` | object | No | Descope field rarSettings. |
| `ciba_settings` | object | No | Descope field cibaSettings. |
| `login_page_url` | string | Yes | Descope field loginPageUrl. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `default_audience` | string | No | Descope field defaultAudience. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `attributes_scopes` | array | No | Descope field attributesScopes. |
| `client_assertions` | array | No | clientAssertions are the private_key_jwt trust entries (JWKS URL or PEM public key per entry). |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `audience_whitelist` | array | No | Descope field audienceWhitelist. |
| `client_auth_method` | string | No | clientAuthMethod: "clientSecret" (default when empty), "privateKeyJwt" (only clientAssertions are accepted), "workloadIdentity" (only workloadClientAssertions are accepted) or "mtls" (only a registered mTLS certificate is accepted). |
| `connections_scopes` | array | No | Descope field connectionsScopes. |
| `permissions_scopes` | array | No | Descope field permissionsScopes. |
| `jwt_bearer_disabled` | boolean | No | jwtBearerDisabled rejects the JWT bearer grant (urn:ietf:params:oauth:grant-type:jwt-bearer) for this app. Default false. A public client cannot use this grant. |
| `jwt_bearer_settings` | object | No | string backChannelLogoutUrl = 10 [(validate).string = {url: true, optional: true}]; |
| `scope_claim_mapping` | array | No | scopeClaimMapping is the structured scope→claim model. Consumed by UpdateThirdPartyApplicationV2 (v2 write-replace: attributesScopes is ignored/cleared). v1 ignores this field. |
| `allow_partial_scopes` | boolean | No | Descope field allowPartialScopes. |
| `device_code_disabled` | boolean | No | deviceCodeDisabled rejects the device authorization grant (urn:ietf:params:oauth:grant-type:device_code) for this app. Default false. |
| `id_jag_target_clients` | object | No | Descope field idJagTargetClients. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `refresh_token_disabled` | boolean | No | refreshTokenDisabled rejects the refresh_token grant for this app, so its tokens cannot be refreshed. Default false. |
| `token_exchange_disabled` | boolean | No | tokenExchangeDisabled rejects the token exchange grant (urn:ietf:params:oauth:grant-type:token-exchange) for this app. Default false. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `workload_client_assertions` | array | No | workloadClientAssertions are the workload identity trust entries (SPIFFE trust domain or OIDC issuer per entry). |
| `authorization_code_disabled` | boolean | No | authorizationCodeDisabled rejects the authorization_code grant for this app, including its authorization requests. Default false. |
| `client_credentials_disabled` | boolean | No | clientCredentialsDisabled rejects the client_credentials grant for this app. Default false. A public client cannot use this grant. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update third party application (v2)

**Slug:** `DESCOPE_UPDATE_THIRD_PARTY_APPLICATION_V2`

Update third party application (v2). Update a third party application using the structured scope-claim mapping model, using a valid management key. The legacy attributesScopes field is ignored and cleared.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Descope field id. |
| `logo` | string | No | Descope field logo. |
| `name` | string | Yes | Descope field name. |
| `logo_url` | string | No | Descope field logoUrl. |
| `force_par` | boolean | No | Descope field forcePar. |
| `force_dpop` | boolean | No | Descope field forceDpop. |
| `force_mtls` | boolean | No | Descope field forceMtls. |
| `force_pkce` | boolean | No | Descope field forcePkce. |
| `client_type` | string | No | Descope field clientType. |
| `description` | string | No | Descope field description. |
| `ciba_enabled` | boolean | No | cibaEnabled allows the CIBA grant (urn:openid:params:grant-type:ciba) for this app and requires cibaSettings. Default false. A public client cannot use this grant. |
| `jar_settings` | object | No | JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications |
| `rar_settings` | object | No | Descope field rarSettings. |
| `ciba_settings` | object | No | Descope field cibaSettings. |
| `login_page_url` | string | Yes | Descope field loginPageUrl. |
| `allowed_tenants` | array | No | Descope field allowedTenants. |
| `default_audience` | string | No | Descope field defaultAudience. |
| `session_settings` | object | No | Descope field sessionSettings. |
| `client_assertions` | array | No | clientAssertions are the private_key_jwt trust entries (JWKS URL or PEM public key per entry). |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `audience_whitelist` | array | No | Descope field audienceWhitelist. |
| `client_auth_method` | string | No | clientAuthMethod: "clientSecret" (default when empty), "privateKeyJwt" (only clientAssertions are accepted), "workloadIdentity" (only workloadClientAssertions are accepted) or "mtls" (only a registered mTLS certificate is accepted). |
| `connections_scopes` | array | No | Descope field connectionsScopes. |
| `permissions_scopes` | array | No | Descope field permissionsScopes. |
| `jwt_bearer_disabled` | boolean | No | jwtBearerDisabled rejects the JWT bearer grant (urn:ietf:params:oauth:grant-type:jwt-bearer) for this app. Default false. A public client cannot use this grant. |
| `jwt_bearer_settings` | object | No | Descope field jwtBearerSettings. |
| `scope_claim_mapping` | array | No | Descope field scopeClaimMapping. |
| `allow_partial_scopes` | boolean | No | Descope field allowPartialScopes. |
| `device_code_disabled` | boolean | No | deviceCodeDisabled rejects the device authorization grant (urn:ietf:params:oauth:grant-type:device_code) for this app. Default false. |
| `id_jag_target_clients` | object | No | Descope field idJagTargetClients. |
| `approved_callback_urls` | array | No | Descope field approvedCallbackUrls. |
| `refresh_token_disabled` | boolean | No | refreshTokenDisabled rejects the refresh_token grant for this app, so its tokens cannot be refreshed. Default false. |
| `token_exchange_disabled` | boolean | No | tokenExchangeDisabled rejects the token exchange grant (urn:ietf:params:oauth:grant-type:token-exchange) for this app. Default false. |
| `mtls_client_auth_methods` | object | No | Descope field mtlsClientAuthMethods. |
| `workload_client_assertions` | array | No | workloadClientAssertions are the workload identity trust entries (SPIFFE trust domain or OIDC issuer per entry). |
| `authorization_code_disabled` | boolean | No | authorizationCodeDisabled rejects the authorization_code grant for this app, including its authorization requests. Default false. |
| `client_credentials_disabled` | boolean | No | clientCredentialsDisabled rejects the client_credentials grant for this app. Default false. A public client cannot use this grant. |
| `force_add_all_authorization_info` | boolean | No | Descope field forceAddAllAuthorizationInfo. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `DESCOPE_UPDATE_USER`

Update User. ### Updates a user's details, using a valid management key. This API endpoint will update a user's details of a user utilizing a valid management key. It is important to understand the update will take the configurations for the user provided and will overwrite all user settings. This means that if the user currently has email and phone, but the update only includes email, the phone and other non-provided configurations will be removed. This API endpoint will remove any details that are not provided. It is preferred to use other updates supported by the API, such as the following options: - [Update User Status](/api/management/users/update-user-status) - [Update User Email](/api/management/users/update-user-email) - [Update User Phone](/api/management/users/update-user-phone) - [Update User Display Name](/api/management/users/update-user-display-name) - [Update User Add Tenant](/api/management/users/update-user-add-tenant) - [Update User Remove Tenant](/api/management/user

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `email` | string | No | Descope field email. |
| `phone` | string | No | Descope field phone. |
| `status` | string | No | Descope field status. |
| `picture` | string | No | Descope field picture. |
| `login_id` | string | Yes | Descope field loginId. |
| `given_name` | string | No | Descope field givenName. |
| `role_names` | array | No | Descope field roleNames. |
| `family_name` | string | No | Descope field familyName. |
| `middle_name` | string | No | Descope field middleName. |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |
| `user_tenants` | array | No | Descope field userTenants. |
| `recovery_email` | string | No | Descope field recoveryEmail. |
| `recovery_phone` | string | No | Descope field recoveryPhone. |
| `verified_email` | boolean | No | Descope field verifiedEmail. |
| `verified_phone` | boolean | No | Descope field verifiedPhone. |
| `custom_attributes` | object | No | Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. |
| `family_associations` | array | No | each AssociatedFamily carries its own roleNames and familyScopedAttributes |
| `additional_identifiers` | array | No | Descope field additionalIdentifiers. |
| `session_classification` | string | No | The session classification to assign the user to, by name. Omit the field to leave the current assignment untouched, send an empty string to remove it, and send a name to assign that classification. A name that does not match an existing classification is rejected. |
| `verified_recovery_email` | boolean | No | Descope field verifiedRecoveryEmail. |
| `verified_recovery_phone` | boolean | No | Descope field verifiedRecoveryPhone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Add Families

**Slug:** `DESCOPE_UPDATE_USER_ADD_FAMILIES`

Update User Add Families. Add a user to one or more families, using a valid management key. Each family entry may also set the user's roles and family-scoped attributes for that family in the same call; omitting roleNames/familyScopedAttributes on a family the user already belongs to leaves them unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `family_associations` | array | Yes | Descope field familyAssociations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Add Roles

**Slug:** `DESCOPE_UPDATE_USER_ADD_ROLES`

Update User Add Roles. Add roles to a user, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `role_names` | array | No | Descope field roleNames. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Add Roles

**Slug:** `DESCOPE_UPDATE_USER_ADD_ROLES_V2`

Update User Add Roles. ### Add roles to an existing user, using a valid management key. This API endpoint allows you to add roles to a user granularly without updating all user details. `roleNames` is an array of the role names in string format. The `tenantId` is optional; if provided, the user must be a member of that tenant The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `role_names` | array | No | Descope field roleNames. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Application to User

**Slug:** `DESCOPE_UPDATE_USER_ADD_SSOAPPS`

Add Application to User. ### Add Applications to an existing user, using a valid management key. This API endpoint allows you to add Applications to a user granularly without updating all user details. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Applications](/manage/idpapplications/) for further details on Applications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Add Tenant

**Slug:** `DESCOPE_UPDATE_USER_ADD_TENANT`

Update User Add Tenant. ### Add a tenant to an existing user, using a valid management key. This API endpoint allows you to add a user to a tenant granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Custom Attribute

**Slug:** `DESCOPE_UPDATE_USER_CUSTOM_ATTRIBUTE`

Update User Custom Attribute. ### Update an existing user's custom attributes, using a valid management key. This API endpoint allows you to update a user's custom attributes granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `attribute_key` | string | Yes | Descope field attributeKey. |
| `attribute_value` | string | No | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Display Name

**Slug:** `DESCOPE_UPDATE_USER_DISPLAY_NAME`

Update User Display Name. ### Updates an existing user's display name, using a valid management key. This API endpoint allows you to update the user's display name granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Descope field name. |
| `login_id` | string | Yes | Descope field loginId. |
| `given_name` | string | No | Descope field givenName. |
| `family_name` | string | No | Descope field familyName. |
| `middle_name` | string | No | Descope field middleName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Email

**Slug:** `DESCOPE_UPDATE_USER_EMAIL`

Update User Email. ### Updates an existing user's email, using a valid management key. This API endpoint allows you to update the user's email granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Descope field email. |
| `login_id` | string | Yes | Descope field loginId. |
| `verified` | boolean | No | Descope field verified. |
| `fail_on_conflict` | boolean | No | Descope field failOnConflict. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Impersonation Consent

**Slug:** `DESCOPE_UPDATE_USER_IMPERSONATION_CONSENT`

Update User Impersonation Consent. Update user impersonation consent, using a valid management key. This allows granting impersonation consent without requiring the user-facing consent flow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | No | tenantId scopes the consent to a single tenant: impersonation is then allowed only into that tenant. Optional so that callers that do not know about scoping leave an existing scope alone; send an explicit empty string to clear it and allow every tenant the user belongs to. |
| `impersonation_consent` | integer | No | Descope field impersonationConsent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Login ID

**Slug:** `DESCOPE_UPDATE_USER_LOGIN_ID`

Update User Login ID. ### Updates an existing user's login ID, using a valid management key. This API endpoint allows you to update a user's Login ID. If you'd like to remove a login ID, provide an empty string for the new login ID. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `new_login_id` | string | No | Descope field newLoginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Phone

**Slug:** `DESCOPE_UPDATE_USER_PHONE`

Update User Phone. ### Updates an existing user's phone number, using a valid management key. This API endpoint allows you to update the user's phone number granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | No | Descope field phone. |
| `login_id` | string | Yes | Descope field loginId. |
| `verified` | boolean | No | Descope field verified. |
| `fail_on_conflict` | boolean | No | Descope field failOnConflict. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Picture

**Slug:** `DESCOPE_UPDATE_USER_PICTURE`

Update User Picture. ### Update an existing user's profile picture, using a valid management key. This API endpoint allows you to update a user's profile picture granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `picture` | string | No | Descope field picture. |
| `login_id` | string | Yes | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Recovery Email

**Slug:** `DESCOPE_UPDATE_USER_RECOVERY_EMAIL`

Update User Recovery Email. Update user recovery email, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `verified` | boolean | No | Descope field verified. |
| `recovery_email` | string | No | Descope field recoveryEmail. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Recovery Phone

**Slug:** `DESCOPE_UPDATE_USER_RECOVERY_PHONE`

Update User Recovery Phone. Update user recovery phone, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `verified` | boolean | No | Descope field verified. |
| `recovery_phone` | string | No | Descope field recoveryPhone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Remove Families

**Slug:** `DESCOPE_UPDATE_USER_REMOVE_FAMILIES`

Update User Remove Families. Remove a user from one or more families, using a valid management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `family_ids` | array | Yes | Descope field familyIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Remove Roles

**Slug:** `DESCOPE_UPDATE_USER_REMOVE_ROLES`

Update User Remove Roles. ### Remove roles from an existing user, using a valid management key. This API endpoint allows you to remove roles from a user granularly without updating all user details. `roleNames` is an array of the role names in string format. The `tenantId` is optional; if provided, the user must be a member of that tenant The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `role_names` | array | No | Descope field roleNames. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Application to User

**Slug:** `DESCOPE_UPDATE_USER_REMOVE_SSOAPPS`

Remove Application to User. ### Remove Applications from an existing user, using a valid management key. This API endpoint allows you to remove Applications from a user granularly without updating all user details. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Applications](/manage/idpapplications/) for further details on Applications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Remove Tenant

**Slug:** `DESCOPE_UPDATE_USER_REMOVE_TENANT`

Update User Remove Tenant. ### Removes a tenant from an existing user, using a valid management key. This API endpoint allows you to remove a user from a tenant granularly without updating all user details. The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | Yes | Descope field tenantId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Trusted Devices

**Slug:** `DESCOPE_UPDATE_USER_REMOVE_TRUSTED_DEVICES`

Delete Trusted Devices. Delete user trusted devices by IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | The user's login identifier (external ID) or ID |
| `device_ids` | array | No | Trusted device IDs to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set User's Roles

**Slug:** `DESCOPE_UPDATE_USER_SET_ROLES`

Set User's Roles. ### Set an existing user's roles, using a valid management key. This API endpoint allows you to set a user's roles. This will override the current roles associated to the user and will set all passed roles. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `role_names` | array | No | Descope field roleNames. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Applications to User

**Slug:** `DESCOPE_UPDATE_USER_SET_SSOAPPS`

Set Applications to User. ### Set Applications for an existing user, using a valid management key. This API endpoint allows you to set the associated Applications for a user. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Applications](/manage/idpapplications/) for further details on Applications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login_id` | string | Yes | Descope field loginId. |
| `sso_app_ids` | array | No | Descope field ssoAppIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Status

**Slug:** `DESCOPE_UPDATE_USER_STATUS`

Update User Status. ### Updates an existing user's status, using a valid management key. This API endpoint allows you to update the user's status granularly without updating all user details. Available statuses to utilize: - invited - enabled - disabled The response returns the user's details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string | Yes | Descope field status. |
| `login_id` | string | Yes | Descope field loginId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload tenant API key for outbound app

**Slug:** `DESCOPE_UPLOAD_OUTBOUND_APP_TENANT_APIKEY`

Upload tenant API key for outbound app. Upload/set a static API key for a tenant on an apikey-type outbound application, using a valid management key. An optional externalIdentifier lets you store multiple keys for the same tenant and application, each addressable by that identifier when fetching the token. Uploading again with the same externalIdentifier (or with none) replaces the existing key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `api_key` | string | Yes | Descope field apiKey. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `external_identifier` | string | No | Descope field externalIdentifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Outbound App Tenant OAuth Token

**Slug:** `DESCOPE_UPLOAD_OUTBOUND_APP_TENANT_OAUTH_TOKEN`

Upload Outbound App Tenant OAuth Token. ### Upload a tenant OAuth token for an outbound application Import a pre-existing tenant-scoped OAuth token into an outbound application without requiring the user to re-run the OAuth flow. Requires a management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `scopes` | array | No | Descope field scopes. |
| `id_token` | string | No | Descope field idToken. |
| `tenant_id` | string | Yes | Descope field tenantId. |
| `granted_by` | string | No | Descope field grantedBy. |
| `access_token` | string | No | Descope field accessToken. |
| `refresh_token` | string | No | Descope field refreshToken. |
| `verify_refresh` | boolean | No | Descope field verifyRefresh. |
| `access_token_type` | string | No | Descope field accessTokenType. |
| `access_token_expiry` | integer | No | Descope field accessTokenExpiry. |
| `external_identifier` | string | No | Descope field externalIdentifier. |
| `refresh_token_expiry` | integer | No | Descope field refreshTokenExpiry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload user API key for outbound app

**Slug:** `DESCOPE_UPLOAD_OUTBOUND_APP_USER_APIKEY`

Upload user API key for outbound app. Upload/set a static API key for a user on an apikey-type outbound application, using a valid management key. An optional externalIdentifier lets you store multiple keys for the same user and application, each addressable by that identifier when fetching the token. Uploading again with the same externalIdentifier (or with none) replaces the existing key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `api_key` | string | Yes | Descope field apiKey. |
| `user_id` | string | Yes | Descope field userId. |
| `tenant_id` | string | No | Descope field tenantId. |
| `external_identifier` | string | No | Descope field externalIdentifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Outbound App User OAuth Token

**Slug:** `DESCOPE_UPLOAD_OUTBOUND_APP_USER_OAUTH_TOKEN`

Upload Outbound App User OAuth Token. ### Upload a user OAuth token for an outbound application Import a pre-existing user-scoped OAuth token into an outbound application without requiring the user to re-run the OAuth flow. Requires a management key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Descope field appId. |
| `scopes` | array | No | Descope field scopes. |
| `user_id` | string | Yes | Descope field userId. |
| `id_token` | string | No | Descope field idToken. |
| `tenant_id` | string | No | Descope field tenantId. |
| `granted_by` | string | No | Descope field grantedBy. |
| `access_token` | string | No | Descope field accessToken. |
| `refresh_token` | string | No | Descope field refreshToken. |
| `verify_refresh` | boolean | No | Descope field verifyRefresh. |
| `access_token_type` | string | No | Descope field accessTokenType. |
| `access_token_expiry` | integer | No | Descope field accessTokenExpiry. |
| `external_identifier` | string | No | Descope field externalIdentifier. |
| `refresh_token_expiry` | integer | No | Descope field refreshTokenExpiry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Available Custom Attributes

**Slug:** `DESCOPE_USER_CUSTOM_ATTRIBUTES`

Get Available Custom Attributes. ### Get available custom attributes to configure on users within a project, using a valid management key. This API endpoint will return the available user custom attributes within a project. ### See also - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Users Authentication History V2

**Slug:** `DESCOPE_USERS_AUTH_HISTORY_V2`

Users Authentication History V2. Load users' authentication history by user IDs, using a valid management key. V2 endpoint with improved request body handling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_ids` | array | No | Descope field userIds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate JWT Template

**Slug:** `DESCOPE_VALIDATE_JWT_TEMPLATE`

Validate JWT Template. Dry-run validate a JWT template without saving. Pass either an inline `template` payload (to validate before create/update) or an existing `id` (to lint a saved template). Returns a list of `ValidationIssue`s — empty list means valid.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Descope field id. |
| `template` | object | No | Descope field template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Project Snapshot

**Slug:** `DESCOPE_VALIDATE_SNAPSHOT`

Validate Project Snapshot. ### Validate a project snapshot utilizing a management key. This endpoint allows you to validate a project snapshot before importing it. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | object | Yes | Descope field files. |
| `excludes` | array | No | Descope field excludes. |
| `input_secrets` | object | No | Descope field inputSecrets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load a list of relations for the given target including all derived relations

**Slug:** `DESCOPE_WHAT_CAN_TARGET_ACCESS`

Load a list of relations for the given target including all derived relations. Load a list of relations for the given target including all derived relations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target` | string | Yes | Descope field target. |
| `context` | object | No | Optional flat key-value context for evaluating ABAC conditions and facts. Relations gated by a condition are returned only when this context satisfies it (same semantics as Check). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Load the resources that the target has the given relation to including all derived relationss

**Slug:** `DESCOPE_WHAT_CAN_TARGET_ACCESS_WITH_RELATION`

Load the resources that the target has the given relation to including all derived relationss. Load the resources that the target has the given relation to including all derived relations

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target` | string | Yes | Descope field target. |
| `context` | object | No | Optional flat key-value context for evaluating ABAC conditions and facts. Resources reachable only through a condition-gated relation are returned only when this context satisfies it (same as Check). |
| `namespace` | string | Yes | Descope field namespace. |
| `parent_target` | string | No | Descope field ParentTarget. |
| `relation_definition` | string | Yes | Descope field relationDefinition. |
| `parent_relation_definition` | string | No | Descope field ParentRelationDefinition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query who can access resource with relation

**Slug:** `DESCOPE_WHO_CAN_ACCESS`

Query who can access resource with relation. Return a list of users who can access a given resource with given relation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context` | object | No | Optional flat key-value context for evaluating ABAC conditions and facts. Targets whose relation is gated by a condition are returned only when this context satisfies it (same semantics as Check). |
| `resource` | string | Yes | Descope field resource. |
| `namespace` | string | Yes | Descope field namespace. |
| `target_type` | string | No | Optional: when set, only targets of this type (namespace) are returned. Empty returns all targets. |
| `relation_definition` | string | Yes | Descope field relationDefinition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
