Security & Identity Tools

Add Descope to your AI agent

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

Things your agent can do in Descope
449

Things your AI can do in Descope

Your FormWise AI can handle any of these in Descope — on its own, without you needing to click a button.

  • 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.

  • Batch 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.

  • Activate SCIM Access 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.

  • Add IPs to List

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

  • Add a named SSO application 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).

  • Add Texts to List

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

  • Add a named 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).

  • Anonymous User

    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.

  • 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.

  • AuthZEN Action Search

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

  • AuthZEN Access Evaluation

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

  • AuthZEN Access 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).

Show 437 more things it can do
  • AuthZEN 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).

  • AuthZEN Subject Search

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

  • 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.

  • 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.

  • Check FGA Permission

    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.

  • Check IP in List

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

  • 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.

  • Clear List

    Clear List. Clear all IPs from a list

  • 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.

  • 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.

  • Complete External Authentication

    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.

  • Update Tenant 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.

  • Enable or disable an SSO configuration

    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.

  • Set Tenant's OIDC Settings

    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.

  • Configure SSO Redirect URL

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

  • Set Tenant's SAML Settings

    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.

  • Set Tenant's SAML Settings via Metadata URL

    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.

  • Update Tenant Session 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.

  • 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.

  • 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.

  • Create auth access policy 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.

  • 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

  • Create Descoper

    Create Descoper. Create a descoper

  • Create dynamic registration template

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

  • 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.

  • Create Family

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

  • Create Family Custom Attribute

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

  • Create Family Dependent

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

  • Create FGA Backup

    Create FGA Backup. Create a new FGA backup.

  • Create FGA Relations

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

  • Save FGA Schema

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

  • 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.

  • 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.

  • Create List

    Create List. Create a new list

  • 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.

  • 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.

  • Create 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.

  • Create Outbound App

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

  • Create outbound application according to existing 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.

  • Create outbound application by existing template

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

  • Create outbound SCIM configuration

    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.

  • 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.

  • Bulk Create Permissions

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

  • Create policy rule

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

  • Create Project

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

  • Create a list of authz relations

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

  • 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.

  • Create Role

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

  • Bulk Create Roles

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

  • Create SCIM Access 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.

  • Create SSO application custom attribute definitions

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

  • Create SSO application permission

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

  • Create SSO application 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.

  • Create OIDC Application

    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.

  • Create SAML Application

    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.

  • Create SSO WS-Fed IDP application

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

  • Create Tenant

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

  • Create tenant auth access policy 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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

  • Create a Custom Attributes

    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.

  • Create Family-Scoped User 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.

  • Batch 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

  • 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.

  • Batch 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.

  • 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.

  • 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.

  • Batch 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.

  • Delete All FGA Relations

    Delete All FGA Relations. Delete all project FGA relations

  • 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.

  • Delete auth access policy rule

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

  • 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.

  • Delete Descoper

    Delete Descoper. Delete a descoper

  • Delete dynamic registration template

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

  • Delete dynamic registration templates

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

  • Delete engine

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

  • Delete Family

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

  • 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.

  • Delete Family Dependent

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

  • Delete FGA Backup

    Delete FGA Backup. Delete an FGA backup.

  • Delete FGA Relations

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

  • Delete flow

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

  • Delete Flow

    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.

  • Delete JWT Template

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

  • Delete List

    Delete List. Delete a list by ID

  • Delete Management Key

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

  • Delete MCP Server Client

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

  • Delete MCP Server Clients

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

  • Delete 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.

  • Delete an authz namespace

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

  • Delete OAuth provider

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

  • Delete Outbound App

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

  • Delete outbound application token by id

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

  • Delete outbound application tokens by appId or userId

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

  • Delete outbound SCIM configuration

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

  • 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.

  • Bulk Delete Permissions

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

  • Delete policy rule

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

  • Delete Project

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

  • Delete Project

    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.

  • Delete an authz relation definition

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

  • Delete a list of authz relations

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

  • Delete all relations for a list of resources

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

  • 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.

  • Delete all relations with matching resourceIds for a list of 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.

  • Delete resources batch

    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.

  • 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.

  • Batch 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.

  • Delete an authz schema

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

  • Delete Scope Claim Mapping

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

  • 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.

  • Delete Application

    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.

  • Delete SSO application custom attribute definitions

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

  • Delete SSO application 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.

  • Delete SSO application 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.

  • Delete Tenant's SAML/OIDC Settings

    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.

  • 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.

  • 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.

  • Delete tenant auth access policy rule

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

  • 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.

  • 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.

  • Delete third party application

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

  • 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.

  • Delete third party application consents by tenant

    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`.

  • Batch delete third party applications

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

  • 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.

  • 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.

  • Delete a Custom Attributes

    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.

  • Delete Family-Scoped User 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.

  • Batch 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.

  • Delete widget

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

  • Validate an authz schema and preview the changes

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

  • Generate Embedded Link

    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.

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

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

  • Expire User Passwsord

    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.

  • 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.

  • Export Flow Localization

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

  • Export Messaging Localization

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

  • 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.

  • Export Project 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.

  • 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

  • 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.

  • 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.

  • 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.

  • 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.

  • Generate Enchanted Link

    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.

  • Generate JWT for Sign-In

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

  • Generate JWT for Sign-Up

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

  • Generate JWT for Sign-Up or Sign-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.

  • Generate Magic Link

    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.

  • Generate OTP

    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.

  • Generate SSO Admin Link

    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.

  • Get access key attribute

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

  • Get admin portal settings

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

  • Get All Lists

    Get All Lists. Get all lists

  • Get auth access policy rule

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

  • Get auth access policy 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.

  • 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.

  • 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`.

  • 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

  • Get Descoper

    Get Descoper. Get a descoper

  • Get embedded link settings

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

  • Get enchanted link settings

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

  • Get Family Custom Attributes

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

  • Get Family Settings

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

  • Get Mappable Resources

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

  • Get FGA Backup

    Get FGA Backup. Get an FGA backup by ID.

  • Get Mappable Schema

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

  • Get FGA Schema

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

  • Get flow

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

  • 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.

  • 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.

  • Get List

    Get List. Get a list by ID

  • Get List By Name

    Get List By Name. Get a list by name

  • Get magic link settings

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

  • 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.

  • Get Management Key

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

  • 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.

  • Get template

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

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

    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.

  • Get OAuth provider

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

  • Get OAuth settings

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

  • Get OTP settings

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

  • Get passkey settings

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

  • Get Tenant 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.

  • Get password settings

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

  • Get project settings

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

  • 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.

  • Get session classification

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

  • Get SSO application permission

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

  • Get SSO application role

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

  • Get SSO application secret by application ID

    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.

  • Get SSO settings

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

  • Authenticated SSO Admin Link

    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.

  • Generate tenant admin SSO configuration links (batch)

    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

  • Get tenant attribute

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

  • Get tenant auth access policy rule

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

  • Get tenant auth access policy 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.

  • Get OTP Settings for a tenant

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

  • Get Tenant Session 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.

  • 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.

  • 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.

  • Get TOTP settings

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

  • Get User

    Retrieve one user by login ID or Descope user ID.

  • Get user attribute

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

  • Get Family-Scoped User Custom Attributes

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

  • 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

  • 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.

  • Get widget

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

  • Check a list of relation queries

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

  • Impersonate User

    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

  • 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.

  • Impersonate Stepup

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

  • Import Access Key

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

  • 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.

  • Import Flow Localization

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

  • Import Lists

    Import Lists. Import multiple lists

  • Import Messaging Localization

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

  • 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

  • Import Project 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.

  • 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

  • Import User Passkeys

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

  • List Descopers

    List Descopers. List descopers

  • List FGA Backups

    List FGA Backups. List all FGA backups.

  • List Flow Templates

    List Flow Templates. List all available flow templates

  • List/Search 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.

  • 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.

  • 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.

  • List Permissions

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

  • List Projects

    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.

  • List Roles

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

  • List Trusted Devices

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

  • List Outbound Apps with 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.

  • List User Passkeys

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

  • List all widgets

    List all widgets. List all widgets in project

  • Load An 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.

  • Load all auth access policy rules

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

  • 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.

  • 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.

  • Load all dynamic registration templates

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

  • Load all resources

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

  • Load all session classifications

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

  • Load All Applications

    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.

  • Load all SSO Settings for a tenant

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

  • Load all tenant auth access policy rules

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

  • 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.

  • Load All third party applications

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

  • 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.

  • Load dynamic registration template

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

  • Load engine by ID

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

  • Load all engines

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

  • Load All Members of a specific External Group

    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.

  • Load All External Groups for a Tenant

    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.

  • Load JWT Template

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

  • 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.

  • Load MCP Server Client

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

  • Load All External Groups for Specific Members

    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.

  • Get Outbound App by ID

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

  • List All Outbound Apps

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

  • Load outbound SCIM configuration

    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).

  • Load policy rule

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

  • Load policy rule settings

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

  • Load Project

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

  • Load resource by ID

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

  • 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.

  • Load FGA Resources

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

  • Load an authz schema

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

  • Load SCIM Access 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.

  • Load Application by ID

    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.

  • Get Tenant's SAML/OIDC Settings

    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.

  • Load Tenant By ID

    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.

  • Load third party application by ID

    Load third party application by ID. Loads project third party application by id, using a valid management key.

  • Load third party application by ID (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.

  • Load Users

    Load Users. Load users by their IDs, using a valid management key.

  • Log user out of all sessions

    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.

  • Logout Users from All 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.

  • Create New SSO Settings

    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.

  • Patch third party application

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

  • 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.

  • 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.

  • Patch Users Batch

    Patch Users Batch. Patch users in batch, using a valid management key.

  • Recalculate SSO Mappings

    Recalculate SSO Mappings. Recalculate SSO group to role mappings for all users in a tenant, using a valid management key.

  • Remove IPs from List

    Remove IPs from List. Remove one or more IPs from an existing IP list

  • Remove SSO User from Tenant

    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.

  • Remove Texts from List

    Remove Texts from List. Remove one or more text items from an existing text list

  • Remove User Passkey

    Remove User Passkey. Remove a specific passkey for a user by credential ID, using a valid management key.

  • Delete User's 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.

  • Remove User Recovery Codes

    Remove User Recovery Codes. Remove (revoke) all recovery codes for a user, using a valid management key.

  • Delete User's TOTP Seed

    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.

  • Reorder auth access policy 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.

  • Reorder a 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.

  • Reorder tenant auth access policy 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.

  • Update 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.

  • 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.

  • Load a list of defined relations for the given resource

    Load a list of defined relations for the given resource. Load a list of defined relations for the given resource.

  • Restore FGA Backup

    Restore FGA Backup. Restore from an FGA backup. This operation is irreversible and may invalidate prior credentials, sessions, or configuration.

  • 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`.

  • Revoke SCIM Access 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.

  • Revoke a named SSO application 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.

  • Revoke SSO Admin Link

    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.

  • Revoke a named 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.

  • 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.

  • 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.

  • 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.

  • Rotate SCIM Access 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.

  • Rotate SSO application secret by application ID

    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.

  • Rotate third party application secret by application ID

    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.

  • Run Management Flow

    Run Management Flow. Run a management flow, using a valid management key.

  • Run Management Flow asynchronously

    Run Management Flow asynchronously. Run a management flow asynchronously, using a valid management key.

  • Save an authz namespace

    Save an authz namespace. Save (create or update) an authz namespace for your project.

  • Save an authz relation definition

    Save an authz relation definition. Save (create or update) an authz relation definition for your project.

  • Save FGA Resources

    Save FGA Resources. ### Save FGA resources This endpoint allows you to save resources for Fine-Grained Authorization.

  • Save an authz schema

    Save an authz schema. Save (create or update) an authz schema for your project.

  • 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.

  • 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.

  • Search Analytics

    Search Analytics. Search analytics (summarized) data grouped by time periods, using a valid management key.

  • 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.

  • Search Families

    Search Families. Search families, using a valid management key.

  • Search for FGA mappable resources

    Search for FGA mappable resources. Search for FGA mappable resources.

  • 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.

  • Search Management Keys

    Search Management Keys. Search management keys using another management key.

  • Search MCP Server Clients

    Search MCP Server Clients. Search MCP Server Clients for a specific MCP Server, using a valid management key.

  • Search policy rules

    Search policy rules. Search policy rule rows by filters (text, action_kind, effect, principal_type, resource_type, enabled). Paged and sorted.

  • 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.

  • Search Tenants

    List or filter project tenants by IDs, names, domains, attributes, authentication type, or hierarchy.

  • Search test Users

    Search test Users. Search test users, using a valid management key.

  • 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.

  • Search Users

    Search project users with identity, tenant, role, status, authentication-state, and time filters; returns one offset-controlled page.

  • Send SSO Admin Link

    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.

  • 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.

  • Set admin portal settings

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

  • Set auth access policy 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.

  • Set embedded link settings

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

  • Set enchanted link settings

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

  • Set Family Settings

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

  • 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.

  • Update 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.

  • Set magic link settings

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

  • Set OAuth provider

    Set OAuth provider. Create or update a single OAuth provider, using a valid management key.

  • Set OAuth settings

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

  • Set OTP settings

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

  • Enable or disable an outbound SCIM configuration

    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.

  • Set passkey settings

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

  • Set password settings

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

  • Set project settings

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

  • 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.

  • 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.

  • Set SSO settings

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

  • 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.

  • Set tenant auth access policy 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.

  • Set OTP Settings for a tenant

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

  • 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.

  • Set TOTP settings

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

  • Set Active Password for User

    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.

  • Set user attribute

    Set user attribute. Create or update a single user custom attribute definition (upsert by machine name), using a valid management key.

  • Set Temporary Password for User

    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.

  • Update 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.

  • 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.

  • Get SSO application custom attribute definitions

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

  • Stop Family Impersonation

    Stop Family Impersonation. Stop impersonating a family dependent and return to the acting admin's own session

  • Stop Impersonation

    Stop Impersonation. Stop impersonation as a different user

  • Load a list of defined relations for the given list of targets

    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.

  • 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.

  • Update auth access policy 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.

  • 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`).

  • Update Descoper

    Update Descoper. Update a descoper

  • Update dynamic registration template

    Update dynamic registration template. Update an existing dynamic registration template, using a valid management key.

  • Update engine

    Update engine. Update an existing engine, using a valid management key.

  • 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.

  • 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.

  • 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.

  • Update List

    Update List. Update an existing list

  • 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.

  • Update MCP Server Client

    Update MCP Server Client. Update an MCP Server Client, using a valid management key.

  • Update template

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

  • Update Outbound App

    Update Outbound App. ### Update outbound application This endpoint allows you to update an existing outbound application.

  • Update outbound SCIM configuration

    Update outbound SCIM configuration. Update an existing outbound SCIM configuration, using a valid management key.

  • 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.

  • Bulk Update Permissions

    Bulk Update Permissions. Bulk update Permissions, using a valid management key.

  • Update policy rule

    Update policy rule. Replace an existing policy rule row matched by id.

  • 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.

  • 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.

  • Rename Project

    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.

  • 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.

  • 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.

  • 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.

  • Bulk Update Roles

    Bulk Update Roles. Bulk update Roles, using a valid management key.

  • Update SSO application permission

    Update SSO application permission. Update an SSO application permission by application id and permission id, using a valid management key.

  • Update SSO application 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.

  • Update OIDC Application

    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.

  • Update SSO Provider IDs

    Update SSO Provider IDs. Update SSO provider IDs and SCIM provider IDs for tenant SSO settings. This endpoint is not publicly documented.

  • Update SAML Application

    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.

  • Update SSO WS-Fed IDP application

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

  • Update Tenant

    Patch selected fields of one tenant while leaving omitted fields unchanged.

  • Update tenant auth access policy 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.

  • Update Tenant Default Roles

    Update Tenant Default Roles. Update tenant default roles, using a valid management key.

  • 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.

  • Update third party application

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

  • 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.

  • 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

  • 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.

  • Update User Add Roles

    Update User Add Roles. Add roles to a user, using a valid management key.

  • Update User Add Roles

    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.

  • Add Application to User

    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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • Update User Recovery Email

    Update User Recovery Email. Update user recovery email, using a valid management key.

  • Update User Recovery Phone

    Update User Recovery Phone. Update user recovery phone, using a valid management key.

  • Update User Remove Families

    Update User Remove Families. Remove a user from one or more families, using a valid management key.

  • 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.

  • Remove Application to User

    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.

  • 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.

  • Delete Trusted Devices

    Delete Trusted Devices. Delete user trusted devices by IDs.

  • Set User's 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.

  • Set Applications to User

    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.

  • 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.

  • Upload tenant API key for outbound app

    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.

  • 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.

  • Upload user API key for outbound app

    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.

  • 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.

  • Get Available 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.

  • Users Authentication 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.

  • 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.

  • Validate Project 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.

  • 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. Load a list of relations for the given target including all derived relations.

  • 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 relationss. Load the resources that the target has the given relation to including all derived relations

  • Query who can access resource with relation

    Query who can access resource with relation. Return a list of users who can access a given resource with given relation.

Built for the way you actually work

No code, no engineers

Connect in a few clicks and start using your AI right away. If you can use the apps you already love, you can do this.

Sounds like you, not like a bot

Train your AI on your offer, your voice, and the way you actually talk to clients — it picks up where you leave off.

Plugs into the stack you already use

No need to rip out your CRM, your scheduler, or your email tool. Your AI works inside the apps running your business today.

Your data stays yours

Client conversations, lists, and credentials are scoped to your workspace. Nothing gets shared, sold, or used to train anyone else’s AI.

What you can do once Descope is connected

Onboard new clients without lifting a finger

When someone signs up, your AI greets them, sets up their next step in Descope, and keeps the momentum going — even at 2am.

Reply to leads in seconds, not days

Your AI watches Descope for new inquiries, answers questions in your voice, and books the call before they cool off.

Get your weekends back

Hand off the repetitive Descope work — follow-ups, reminders, updates, simple admin — and stop being the bottleneck in your own business.

How to connect Descope to your agent

  1. 1

    Start using FormWise for free

    Sign up in under a minute.

  2. 2

    Find Descope in your connected apps

    Inside FormWise, open Connectors and look for Descope.

  3. 3

    Hit "Connect"

    Click "Connect Descope" and log in like you normally would. We only ask for the permissions your AI actually needs.

  4. 4

    Tell your AI what to do in Descope

    Build a quick AI Agent (it's like writing instructions, not code), and pick the Descope actions you want your AI to handle.

  5. 5

    Watch it run

    Send it a real-world task and watch your AI take care of Descope for you. Tweak the wording until it feels just right.

Powered by the AI you already trust

Your Descope workflow runs on the same world-class AI used by ChatGPT, Claude, and Gemini. We handle the technical part — you just tell your AI what to do, in plain English.

  • OpenAI
  • Anthropic Claude
  • Google Gemini

Questions other Descope users had before signing up

Do I need to know how to code?

Not even a little. If you can use Descope today, you can set this up. You'll connect Descope, tell your AI what it should help with, and you're live. The whole thing is built for coaches, course creators, agencies, and operators — not engineers.

Will my clients know they're talking to an AI?

Only if you want them to. Your FormWise AI is trained on your voice, your offer, and the way you actually communicate — so it sounds like a thoughtful team member, not a clunky chatbot. Most people can't tell.

Can I make it sound like me?

Yes. You can give your AI examples of how you write, the questions you usually ask new clients, the way you handle objections, and the language you use about your offer. The more you give it, the more it sounds like you wrote it.

What if I want to take over a conversation?

You're always in control. You can step in at any point, take over from your AI, or stop it from sending messages until you've reviewed them. Think of it as a teammate, not a replacement.

Is my client data safe?

Yes. Your Descope login and client information stay scoped to your workspace. We don't sell it, we don't share it, and we don't use your data to train anyone else's AI. You can disconnect Descope or delete everything any time.

What happens when Descope updates their app?

We handle it. When Descope adds new features or changes how something works, we update the integration in the background. You don't have to do anything — your AI just keeps working.

How fast can I actually get this running?

Most people are up and running the same day they sign up. Connecting Descope takes a few minutes. Teaching your AI to handle the work the way you'd want it done is the part worth slowing down for.

What is FormWise?

FormWise is the AI agent builder for coaches, course creators, and agencies. You connect the apps you already use — like Descope — train your AI on your offer and voice, and let it handle the work you've been doing manually: onboarding, follow-ups, support, admin. No code, no developers, no engineering team required.

Can I sell AI agents to my clients?

Yes. A lot of FormWise users build AI assistants and sell them as part of their offer — done-for-you AI setups, white-label assistants for client businesses, custom GPTs trained on a client's brand. You can charge a setup fee, a monthly retainer, or both.

Can I embed my AI on my website or in my course?

Yes. Every AI you build in FormWise can be embedded on your site, dropped into your course platform, or shared as a standalone link. Your clients and students just open it like any other web page — no app to download, no login hoops.

Do I need to know anything about AI to use this?

No. If you can describe what you want your AI to do in plain English — "greet new clients, ask these 3 questions, book them a call" — FormWise can build it. We handle the models, the prompts, the connections. You handle the part you already know: what your business actually needs.

About Descope on FormWise

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

Connect Descope once and your FormWise AI gets 449 things it can do inside it. That means your AI can handle the Descope work in your business — the messages, the updates, the follow-ups, the admin — the way you would, just faster and around the clock.

You don't need to know how any of it works under the hood. We take care of keeping the connection alive, retrying if something fails, and making sure your data only ever moves where you tell it to.

New to Descope? Take a look at www.descope.com.

Stop doing the Descope work yourself

Hand it off to an AI assistant that sounds like you, works around the clock, and never forgets a follow-up. Free to start.