{ "opencollection": "1.0.0", "info": { "name": "Descope Apps Mgmt API", "version": "0.0.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Mgmt", "type": "folder" }, "items": [ { "info": { "name": "RegisterThirdPartyApplication", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/inboundapp/app/:projectId/register", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Auto fill by proto from the requested URL" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register Third Party Application according to RFC 7591" }, { "info": { "name": "RegisterMcpServerClient", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/client/:projectId/:mcpServerId/register", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Auto fill by proto from the requested URL" }, { "name": "mcpServerId", "value": "", "type": "path", "description": "Auto fill by proto from the requested URL (only in agentic hub)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register MCP Server client according to RFC 7591" }, { "info": { "name": "Load An Access Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/accesskey", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load an access key, using a valid management key.\n\nThis API endpoint allows administrators to load the details of an existing access key.\n\nThe response contains details of the access key including associated roles and tenants as well as details of the key's creation, status, and expiration.\n\n### Next Steps\n\nOnce 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/activa" }, { "info": { "name": "Import Access Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Import an access key by providing its plaintext value, using a valid management key." }, { "info": { "name": "Search Access Keys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Search access keys, using a valid management key.\n\nThis API endpoint allows administrators to search for details of existing access keys for a given array of tenants.\n\nThe 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.\n\n### Next Steps\n\nOnce you have this data, you can utilize the response to [Update an access key](/api/management/access-keys/update-access" }, { "info": { "name": "Create Access Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create an access key, using a valid management key.\n\nThis API endpoint allows administrators to create an access key.\n\nDuring the creation of the access key, you can set the name, expiration time, roles and tenant:role pairs to associated with the key.\n\n### Next Steps\n\nOnce 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).\n\n### See also\n\n- See [Access Key Management](" }, { "info": { "name": "Update Access Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update an existing access key, using a valid management key.\n\nThis API endpoint allows administrators to update an existing access key. With this endpoint, you can only update the access key's name.\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Activate Access Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/activate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Activate an existing access key, using a valid management key.\n\nThis API endpoint allows administrators to activate an existing access key.\n\n### Next Steps\n\nOnce 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).\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Deactivate Access Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/deactivate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Deactivate an existing access key, using a valid management key.\n\nThis API endpoint allows administrators to deactivate an existing access key.\n\nOnce the access key has been deactivated, it's access will be revoked until reactivated.\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Batch Activate Access Keys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/activate/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Activate existing access keys in batch, using a valid management key.\n\nThis API endpoint allows administrators to activate existing access keys in batch.\n\n### Next Steps\n\nOnce 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).\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Batch Deactivate Access Keys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/deactivate/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Deactivate existing access keys in batch, using a valid management key.\n\nThis API endpoint allows administrators to deactivate existing access keys in batch.\n\nOnce the access keys have been deactivated, their access will be revoked until reactivated.\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Batch Delete Access Keys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete existing access keys in batch, using a valid management key.\n\nThis API endpoint allows administrators to delete existing access keys in batch.\n\nOnce the access keys have been deleted, their access will be revoked.\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Delete Access Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/accesskey/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete an existing access key, using a valid management key.\n\nThis API endpoint allows administrators to delete an existing access key.\n\nOnce the access key has been deleted, it's access will be revoked.\n\n### See also\n\n- See [Access Key Management](/access-keys) for further details on managing access keys." }, { "info": { "name": "Search Audit", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/audit/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Search the audit log, using a valid management key.\n\nThis API endpoint allows you to search the audit log utilizing various search parameters and returns the results in JSON format." }, { "info": { "name": "Create Audit Event", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/audit/event", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create an audit log event, using a valid management key.\n\nThis API endpoint allows you to create an audit log utilizing various parameters and returns the results in JSON format." }, { "info": { "name": "Search Analytics", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/analytics/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search analytics (summarized) data grouped by time periods, using a valid management key." }, { "info": { "name": "Load User", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/user", "params": [ { "name": "loginId", "value": "", "type": "query" }, { "name": "userId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load a user's data, using a valid management key.\n\nThis API endpoint takes the user's loginId and then returns details of a user utilizing a valid management key. The response includes the following; however, there are additional items in the response that you can see below by expanding the response 200 OK.\n- loginIds\n- userId\n- name\n- email\n- phone\n- verified settings (phone, email)\n- Tenant configurations - which tenantIds, which roleNames\n\n_Note: Suppose you frequently load a user for a s" }, { "info": { "name": "Create Test User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/create/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a test user, using a valid management key." }, { "info": { "name": "Get User Provider Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/user/provider/token", "params": [ { "name": "loginId", "value": "", "type": "query" }, { "name": "provider", "value": "", "type": "query" }, { "name": "withRefreshToken", "value": "", "type": "query" }, { "name": "forceRefresh", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get an existing user's provider token, using a valid management key.\n\nThis 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).\n\n### Query Params\n\n- `loginId` - The loginId of the user" }, { "info": { "name": "Load Users", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/users/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load users by their IDs, using a valid management key." }, { "info": { "name": "Search Users", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search users, using a valid management key." }, { "info": { "name": "Search test Users", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/user/search/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search test users, using a valid management key." }, { "info": { "name": "Search Users", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/user/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Search for users, using a valid management key.\n\nThis API endpoint will search for users utilizing a valid management key. Searches can be defined with any combination of roles or tenants. You can also only send the request with an empty payload to return all users.\n\nThe response will include the following details on all users within an array of objects:\n- loginIds\n- userId\n- name\n- email\n- phone\n- verified settings (phone, email)\n- Tenant configurations (tenantIds, roleNames)\n\n### Next Step" }, { "info": { "name": "Get User's Login History", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/history", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get an user's login history, using a valid management key.\n\nThis API endpoint will loads the user's login history based on the user's userId.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Patch Users Batch", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.descope.com/v1/mgmt/user/patch/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch users in batch, using a valid management key." }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create a new user, using a valid management key.\n\nThis API endpoint will create a new user utilizing a valid management key.\n\nThis API endpoint allows you to configure all aspects of a user:\n- loginId\n- email\n- phone\n- verified settings (phone, email) - one must be set to true\n- displayName\n- roleNames\n- Tenant configurations - which tenantIds, which roleNames. The userTenants can include multiple items\nEx:\n```\n\"userTenants\": [\n{\n \"tenantId\": \"T2IMjmRfYTQHlbaastz3im59ERS3\",\n \"roleNames\": [" }, { "info": { "name": "Batch Create Users", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/create/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Batch Create Users, using a valid management key.\n\nThis API endpoint will batch create new users utilizing a valid management key.\n\nThis API endpoint allows you to configure all aspects of a user:\n- loginId\n- email\n- phone\n- verified settings (phone, email) - one must be set to true\n- displayName\n- roleNames\n- Tenant configurations - which tenantIds, which roleNames. The userTenants can include multiple items\nEx:\n```\n\"userTenants\": [\n{\n \"tenantId\": \"T2IMjmRfYTQHlbaastz3im59ERS3\",\n \"roleNam" }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates a user's details, using a valid management key.\n\nThis API endpoint will update a user's details of a user utilizing a valid management key.\n\nIt 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.\n\nThis API endpoint will remove any details that are not p" }, { "info": { "name": "Update User Recovery Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/recovery/email", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update user recovery email, using a valid management key." }, { "info": { "name": "Update User Recovery Phone", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/recovery/phone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update user recovery phone, using a valid management key." }, { "info": { "name": "Patch User", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.descope.com/v1/mgmt/user/patch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Patch a user's details, using a valid management key.\n\nThis API endpoint will patch a user's details of a user utilizing a valid management key.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Status", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/status", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates an existing user's status, using a valid management key.\n\nThis API endpoint allows you to update the user's status granularly without updating all user details.\n\nAvailable statuses to utilize:\n- invited\n- enabled\n- disabled\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Impersonation Consent", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/impersonationConsent", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update user impersonation consent, using a valid management key. This allows granting impersonation consent without requiring the user-facing consent flow." }, { "info": { "name": "Update User Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/email", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates an existing user's email, using a valid management key.\n\nThis API endpoint allows you to update the user's email granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Login ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/loginid", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates an existing user's login ID, using a valid management key.\n\nThis API endpoint allows you to update a user's Login ID.\n\nIf you'd like to remove a login ID, provide an empty string for the new login ID.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Phone", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/phone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates an existing user's phone number, using a valid management key.\n\nThis API endpoint allows you to update the user's phone number granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Display Name", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/name", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates an existing user's display name, using a valid management key.\n\nThis API endpoint allows you to update the user's display name granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Add Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/role/add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Add roles to a user, using a valid management key." }, { "info": { "name": "Update User Picture", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/picture", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update an existing user's profile picture, using a valid management key.\n\nThis API endpoint allows you to update a user's profile picture granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further deta" }, { "info": { "name": "Update User Custom Attribute", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/customAttribute", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update an existing user's custom attributes, using a valid management key.\n\nThis API endpoint allows you to update a user's custom attributes granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further " }, { "info": { "name": "Update JWT", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Updates a JWT with custom claims, using a valid management key.\n\nThis API endpoint will update a JWT with custom claims. This endpoint takes the JWT as well as the `customClaims` json." }, { "info": { "name": "Users Authentication History V2", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/user/history", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load users' authentication history by user IDs, using a valid management key. V2 endpoint with improved request body handling." }, { "info": { "name": "Expire User Passwsord", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/password/expire", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Expire an existing user's password, using a valid management key.\n\nThis API endpoint allows you to expire an existing user's password. Upon next login, the user will need to follow the reset password flow.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further details on managing tenants.\n- See [Res" }, { "info": { "name": "List Trusted Devices", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/trusteddevices/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List trusted devices for one or more users." }, { "info": { "name": "Remove User Passkey", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/passkey/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove a specific passkey for a user by credential ID, using a valid management key." }, { "info": { "name": "Import User Passkeys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/passkeys/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Import passkey credentials for a user, using a valid management key." }, { "info": { "name": "List User Passkeys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/passkeys/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all passkeys for a user, using a valid management key." }, { "info": { "name": "Set Active Password for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/password/set/active", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Set an active password for an existing user, using a valid management key.\n\nThis 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.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further details on " }, { "info": { "name": "Delete Trusted Devices", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/trusteddevices/remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete user trusted devices by IDs." }, { "info": { "name": "Set Temporary Password for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/password/set/temporary", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Set a temporary password for an existing user, using a valid management key.\n\nThis 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.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further details on m" }, { "info": { "name": "Delete User's TOTP Seed", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/totp/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete an existing user's TOTP, using a valid management key.\n\nThis API endpoint allows you to delete an existing user's TOTP seed.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Update User Add Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/tenant/add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Add a tenant to an existing user, using a valid management key.\n\nThis API endpoint allows you to add a user to a tenant granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further details on managing te" }, { "info": { "name": "Update User Remove Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/tenant/remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Removes a tenant from an existing user, using a valid management key.\n\nThis API endpoint allows you to remove a user from a tenant granularly without updating all user details.\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Tenants](/management/tenant-management) for further details on " }, { "info": { "name": "Update User Add Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/user/update/role/add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Add roles to an existing user, using a valid management key.\n\nThis API endpoint allows you to add roles to a user granularly without updating all user details.\n\n`roleNames` is an array of the role names in string format.\n\nThe `tenantId` is optional; if provided, the user must be a member of that tenant\n\nThe response returns the user's details in json format.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-use" }, { "info": { "name": "Set User's Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/role/set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Set an existing user's roles, using a valid management key.\n\nThis API endpoint allows you to set a user's roles.\n\nThis will override the current roles associated to the user and will set all passed roles.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Roles](/manage/roles/) for further details on managing roles." }, { "info": { "name": "Update User Remove Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/role/remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Remove roles from an existing user, using a valid management key.\n\nThis API endpoint allows you to remove roles from a user granularly without updating all user details.\n\n`roleNames` is an array of the role names in string format.\n\nThe `tenantId` is optional; if provided, the user must be a member of that tenant\n\nThe response returns the user's details in json format.\n\n### See also\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overvie" }, { "info": { "name": "Add Application to User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/ssoapp/add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Add Applications to an existing user, using a valid management key.\n\nThis API endpoint allows you to add Applications to a user granularly without updating all user details.\n\n### See also\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Applications](/manage/idpapplications/) for further details on Applications." }, { "info": { "name": "Set Applications to User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/ssoapp/set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Set Applications for an existing user, using a valid management key.\n\nThis API endpoint allows you to set the associated Applications for a user.\n\n### See also\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Applications](/manage/idpapplications/) for further details on Applications." }, { "info": { "name": "Remove Application to User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/update/ssoapp/remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Remove Applications from an existing user, using a valid management key.\n\nThis API endpoint allows you to remove Applications from a user granularly without updating all user details.\n\n### See also\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Applications](/manage/idpapplications/) for further details on Applications." }, { "info": { "name": "Log user out of all sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/logout", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Log a user out of all sessions, using a valid management key.\n\nThis API endpoint allows you to log a user out of all active sessions.\n\n### See also\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object.\n- See [Manage Roles](/manage/roles/) for further details on managing roles." }, { "info": { "name": "Delete User's Passkeys", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/passkeys/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a user's Passkeys, using a valid management key.\n\nThis API endpoint will delete all existing passkeys for the user\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a user, using a valid management key.\n\nThis API endpoint will delete a user utilizing a valid management key based on the provided user loginId.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Batch Delete Users", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete users, using a valid management key.\n\nThis API endpoint will delete users utilizing a valid management key.\n\n### See also\n\n- See [Manage Users](/manage/users) for further details on managing users.\n- See [The User Object](/api/overview#the-user-object) for further details on the user object." }, { "info": { "name": "Impersonate User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/impersonate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Impersonate a user, using a valid management key.\n\nThis API endpoint will allow you to impersonate a user using a login ID.\nThe impersonator user must have the impersonation permission in order for this request to work.\nThe response would be a refresh JWT of the impersonated user" }, { "info": { "name": "Anonymous User", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/auth/anonymous", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Anonymous User\nAnonymous Users are identified with a unique Descope JWT type. Eventually, create a token that we can use as the defined anonymous identity.\nSigned by Descope. For more info, please refer to our anonymous users documentation." }, { "info": { "name": "Impersonate Stepup", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/impersonate/stepup", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Impersonate as a different user with step-up claim" }, { "info": { "name": "Stop Impersonation", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/stop/impersonation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop impersonation as a different user" }, { "info": { "name": "Generate JWT for Sign-In", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/auth/signin", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a JWT for an existing user, using a valid management key." }, { "info": { "name": "Generate JWT for Sign-Up", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/auth/signup", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new user and generate a JWT for them, using a valid management key." }, { "info": { "name": "Generate JWT for Sign-Up or Sign-In", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/auth/signup-in", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Save an authz schema", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/schema/save", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Save (create or update) an authz schema for your project." }, { "info": { "name": "Delete an authz schema", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/schema/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an authz schema thus removing authz from your project." }, { "info": { "name": "Load an authz schema", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/schema/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load an authz schema for your project." }, { "info": { "name": "Save an authz namespace", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/ns/save", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Save (create or update) an authz namespace for your project." }, { "info": { "name": "Validate an authz schema and preview the changes", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/schema/dryrun", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Preview schema diff between existing and new schema, without saving it." }, { "info": { "name": "Delete an authz namespace", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/ns/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an authz namespace and remove all related relations." }, { "info": { "name": "Save an authz relation definition", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/rd/save", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Save (create or update) an authz relation definition for your project." }, { "info": { "name": "Delete an authz relation definition", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/rd/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an authz relation definition for your project and remove all related relations." }, { "info": { "name": "Create a list of authz relations", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a list of authz relations." }, { "info": { "name": "Delete a list of authz relations", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a list of authz relations." }, { "info": { "name": "Delete all relations for a list of resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/deleteresources", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete all relations for the given list of resources." }, { "info": { "name": "Delete all relations with matching resourceIds for a list of resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/deleteresourcesrelations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete all relations for the given list of resources in which they are the resource." }, { "info": { "name": "Check a list of relation queries", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/has", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Check a list of relation queries." }, { "info": { "name": "Query who can access resource with relation", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/who", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a list of users who can access a given resource with given relation." }, { "info": { "name": "Load a list of defined relations for the given resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/resource", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a list of defined relations for the given resource." }, { "info": { "name": "Load a list of defined relations for the given list of targets", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/targets", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a list of defined relations for the given list of targets without recursively traversing the relation tree." }, { "info": { "name": "Load a list of relations for the given target including all derived relations", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/targetall", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a list of relations for the given target including all derived relations." }, { "info": { "name": "Load the resources that the target has the given relation to including all derived relationss", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/re/targetwithrelation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load the resources that the target has the given relation to including all derived relations" }, { "info": { "name": "Return the list of targets and resources changed since the given date", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/authz/getmodified", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the list of targets and resources changed since the given date. Should be used to invalidate local caches." }, { "info": { "name": "Get Descoper", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/descoper", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a descoper" }, { "info": { "name": "Create Descoper", "type": "http" }, "http": { "method": "PUT", "url": "https://api.descope.com/v1/mgmt/descoper", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a descoper" }, { "info": { "name": "Update Descoper", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.descope.com/v1/mgmt/descoper", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a descoper" }, { "info": { "name": "Delete Descoper", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/descoper", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a descoper" }, { "info": { "name": "List Descopers", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/descoper/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List descopers" }, { "info": { "name": "Check FGA Permission", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/check", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Check FGA permission\n\nThis endpoint allows you to check if a target has a specific relation to a resource using Fine-Grained Authorization." }, { "info": { "name": "Get FGA Relations", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/relations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get FGA relations\n\nThis endpoint allows you to retrieve relations for a given target or resource using Fine-Grained Authorization." }, { "info": { "name": "Delete All FGA Relations", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/fga/relations", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete all project FGA relations" }, { "info": { "name": "Get Mappable Resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/fga/mappable/resources" }, "docs": "### Get mappable resources\n\nThis endpoint allows you to retrieve mappable resources for Fine-Grained Authorization." }, { "info": { "name": "Search for FGA mappable resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/mappable/resources", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search for FGA mappable resources." }, { "info": { "name": "Delete FGA Relations", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/relations/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete FGA relations\n\nThis endpoint allows you to delete relations using Fine-Grained Authorization." }, { "info": { "name": "Get FGA Schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/fga/schema", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get FGA schema\n\nThis endpoint allows you to retrieve the current Fine-Grained Authorization schema for your project." }, { "info": { "name": "Save FGA Schema", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/schema", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Save FGA schema\n\nThis endpoint allows you to save (create or update) the Fine-Grained Authorization schema for your project." }, { "info": { "name": "Get Mappable Schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/fga/mappable/schema", "params": [ { "name": "tenantId", "value": "", "type": "query" }, { "name": "resourcesLimit", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get mappable schema\n\nThis endpoint allows you to retrieve the mappable schema for Fine-Grained Authorization." }, { "info": { "name": "Load FGA Resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/resources/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load FGA resources\n\nThis endpoint allows you to load resources for Fine-Grained Authorization." }, { "info": { "name": "Save FGA Resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/resources/save", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Save FGA resources\n\nThis endpoint allows you to save resources for Fine-Grained Authorization." }, { "info": { "name": "Create FGA Backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/backup", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new FGA backup." }, { "info": { "name": "Get FGA Backup", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/fga/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an FGA backup by ID." }, { "info": { "name": "Delete FGA Backup", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/fga/backup/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an FGA backup." }, { "info": { "name": "Restore FGA Backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/fga/backup/:backupId/restore", "params": [ { "name": "backupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Restore from an FGA backup." }, { "info": { "name": "List FGA Backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/fga/backups", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all FGA backups." }, { "info": { "name": "Get Management Flow async result", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/async/result", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the result from an async management flow execution (if any), using a valid management key." }, { "info": { "name": "Run Management Flow asynchronously", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/async/run", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run a management flow asynchronously, using a valid management key." }, { "info": { "name": "List/Search Flows", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### List or search flows within a project utilizing a management key.\n\nThis endpoint is used to list or search flows within a project.\n\nTo list all flows, send an empty body such as: `{ }` or `{ \"ids\": [] }`.\n\nTo 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\"] }`.\n\n### See Also\n- See [Flow Overview](/customize/flows/) for more information on flows.\n- See [Manage Flows](/customize/manage_flows" }, { "info": { "name": "Run Management Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/run", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run a management flow, using a valid management key." }, { "info": { "name": "Complete External Authentication", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/externalauth/complete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Export Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/flow/export", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Export an existing flow from a project utilizing a management key.\n\nThis endpoint is used to export an existing flow from a project. The response is the JSON which includes the flow and associated screens.\n\n### See Also\n- See [Flow Overview](/customize/flows/) for more information on flows.\n- See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows." }, { "info": { "name": "Import Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/flow/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Import a flow within a project utilizing a management key.\n\nThis 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.\n\n### See Also\n- See [Flow Overview](/customize/flows/) for more information on flows.\n- See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows." }, { "info": { "name": "Delete Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a flow within a project utilizing a management key.\n\nThis endpoint is used to delete a flow from a project by giving an existing flow ID to be deleted.\n\n### See Also\n- See [Flow Overview](/customize/flows/) for more information on flows.\n- See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows." }, { "info": { "name": "Export Theme", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/theme/export", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Export a theme from a project utilizing a management key.\n\nThis endpoint is used to export a theme from a project. The response is the JSON of the theme.\n\n### See Also\n- See [Styles Overview](/management/project-settings/styles) for more information on styles and themes" }, { "info": { "name": "Import Theme", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/theme/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Import a theme to a project utilizing a management key.\n\nThis endpoint is used to import a theme from a project. The request body for this endpoint can be received from the export theme endpoint.\n\n### See Also\n- See [Styles Overview](/management/project-settings/styles) for more information on styles and themes" }, { "info": { "name": "List Flow Templates", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/flow/template/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all available flow templates" }, { "info": { "name": "Export Flow Localization", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/localization/flow/export", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Export flow localization, using a valid management key." }, { "info": { "name": "Import Flow Localization", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/localization/flow/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Import flow localization, using a valid management key." }, { "info": { "name": "List all widgets", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/widget/list", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all widgets in project" }, { "info": { "name": "Load All External Groups for a Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/group/all", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all external groups for a tenant, using a valid management key.\n\nThis 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.\n\n### Next Steps\n\nAdministrators 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 S" }, { "info": { "name": "Load All External Groups for Specific Members", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/group/member/all", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all external group for specific members, using a valid management key.\n\nThis 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.\n\n### Next Steps\n\nAdministrators can review this information and make changes within th" }, { "info": { "name": "Load All Members of a specific External Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/group/members", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all members of a specific External group, using a valid management key.\n\nThis 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.\n\n### Next Steps\n\nAdministrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-g" }, { "info": { "name": "Create JWT Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Delete JWT Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a JWT template by id. The project's default templates are restored where this one was referenced." }, { "info": { "name": "Apply JWT Template From Library", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/library/apply", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "List JWT Template Library", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/library/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List the curated JWT template library Descope ships — starter templates with documented use cases, optional logos, and `experimental` flags." }, { "info": { "name": "Load JWT Template Library Entry", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/library/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a single library entry by id, including the full claim body — required before applying." }, { "info": { "name": "List JWT Templates", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Load JWT Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a single JWT template by id." }, { "info": { "name": "Update JWT Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing JWT template by id. Same strict validation as CreateJwtTemplate runs first; on failure the existing template is unchanged." }, { "info": { "name": "Validate JWT Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/jwt/templates/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Create List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new list" }, { "info": { "name": "Update List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing list" }, { "info": { "name": "Delete List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a list by ID" }, { "info": { "name": "Get List", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/list/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list by ID" }, { "info": { "name": "Get List By Name", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/list/name/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list by name" }, { "info": { "name": "Get All Lists", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/list/all", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all lists" }, { "info": { "name": "Import Lists", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Import multiple lists" }, { "info": { "name": "Add IPs to List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/ip/add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Add one or more IPs to an existing IP list" }, { "info": { "name": "Remove IPs from List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/ip/remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove one or more IPs from an existing IP list" }, { "info": { "name": "Check IP in List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/ip/check", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Check if a specific IP exists in a list" }, { "info": { "name": "Clear List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/clear", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Clear all IPs from a list" }, { "info": { "name": "Add Texts to List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/text/add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Add one or more text items to an existing text list" }, { "info": { "name": "Remove Texts from List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/text/remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove one or more text items from an existing text list" }, { "info": { "name": "Check Text in List", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/list/text/check", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Check if a specific text exists in a list" }, { "info": { "name": "Rename Project", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/update/name", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Rename a project utilizing a management key.\n\nThis endpoint allows you to update the name of a project. The body only requires the `name` argument.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Export Project", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/export", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Export a project utilizing a management key.\n\nThis endpoint is used to export a project. The response is the JSON of the project items.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Import Project", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Import a project utilizing a management key.\n\nThis 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)\n\nYou can also exclude items from the export when importing by utilizing the flags below within the `exclude` array.\n\n```\nThe entire project:\n project\n\nProject specific items:\n project.domain\n project.trustedDomains\n project.tokenResponseMethod\n project.selfProvisioning\n project.rot" }, { "info": { "name": "Clone Project", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/clone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Clone a project utilizing a management key.\n\nThis endpoint allows you to clone the current project, including its settings and configurations.\n\n_Note: This requires a pro or enterprise tier licenses. Users, tenants and access keys are not cloned._\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Delete Project", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/delete", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a project utilizing a management key.\n\nThis endpoint allows you to delete a project. This action is irreversible, use with caution.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Clone Project (Async)", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/clone/async", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Get Clone Project Process", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/project/clone/async/:processId", "params": [ { "name": "processId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Export Project Snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/snapshot/export", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Export a project snapshot utilizing a management key.\n\nThis endpoint allows you to export a snapshot of the current project state.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Import Project Snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/snapshot/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Import a project snapshot utilizing a management key.\n\nThis endpoint allows you to import a previously exported project snapshot.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Export Messaging Localization", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/localization/messaging/export", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Export messaging localization, using a valid management key." }, { "info": { "name": "Validate Project Snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/snapshot/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Validate a project snapshot utilizing a management key.\n\nThis endpoint allows you to validate a project snapshot before importing it.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Import Messaging Localization", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/localization/messaging/import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Import messaging localization, using a valid management key." }, { "info": { "name": "Update Project Tags", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/project/update/tags", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update project tags utilizing a management key.\n\nThis endpoint allows you to update the tags associated with a project.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "List Projects", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/projects/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### List all projects utilizing a management key.\n\nThis endpoint allows you to list all projects in your account.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." }, { "info": { "name": "Get Management Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/managementkey", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a management key using another management key." }, { "info": { "name": "Create Management Key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.descope.com/v1/mgmt/managementkey", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a management key using another management key." }, { "info": { "name": "Update Management Key", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.descope.com/v1/mgmt/managementkey", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a management key using another management key. All supported fields will be reset if not provided." }, { "info": { "name": "Search Management Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/managementkey/search", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search management keys using another management key." }, { "info": { "name": "Delete Management Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/managementkey/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a management key using another management key." }, { "info": { "name": "Create MCP Server Client", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/client/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an MCP Server Client, using a valid management key." }, { "info": { "name": "Update MCP Server Client", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/client/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an MCP Server Client, using a valid management key." }, { "info": { "name": "Load MCP Server Client", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/client/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load an MCP Server Client by ID, using a valid management key." }, { "info": { "name": "Delete MCP Server Client", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/client/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an MCP Server Client by ID, using a valid management key." }, { "info": { "name": "Delete MCP Server Clients", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/clients/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete multiple MCP Server Clients by IDs, using a valid management key." }, { "info": { "name": "Search MCP Server Clients", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/clients/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search MCP Server Clients for a specific MCP Server, using a valid management key." }, { "info": { "name": "Get MCP Server Client Secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/client/secret", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get MCP Server Client secret, using a valid management key." }, { "info": { "name": "Rotate MCP Server Client Secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/client/secret/rotate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Rotate MCP Server Client secret, using a valid management key." }, { "info": { "name": "Create MCP Server", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an MCP Server, using a valid management key." }, { "info": { "name": "Update MCP Server", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an MCP Server, using a valid management key." }, { "info": { "name": "Load MCP Server", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/load", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load an MCP Server by ID, using a valid management key." }, { "info": { "name": "Delete MCP Server", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/server/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an MCP Server by ID, using a valid management key." }, { "info": { "name": "Delete MCP Servers", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/servers/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete multiple MCP Servers by IDs, using a valid management key." }, { "info": { "name": "Load All MCP Servers", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/mcp/servers/all", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load all MCP Servers for a project, using a valid management key." }, { "info": { "name": "List All Outbound Apps", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/outbound/apps", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### List all outbound applications\n\nThis endpoint allows you to retrieve all outbound applications configured in your project." }, { "info": { "name": "List Outbound Apps with User Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/outbound/apps-with-user-token", "params": [ { "name": "userId", "value": "", "type": "query" }, { "name": "tenantId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### List outbound applications with user token\n\nThis endpoint allows you to retrieve outbound applications that have a user token available." }, { "info": { "name": "Get Outbound App by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/outbound/app/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get outbound application by ID\n\nThis endpoint allows you to retrieve a specific outbound application by its ID." }, { "info": { "name": "Create Outbound App", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create outbound application\n\nThis endpoint allows you to create a new outbound application." }, { "info": { "name": "Update Outbound App", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update outbound application\n\nThis endpoint allows you to update an existing outbound application." }, { "info": { "name": "Delete Outbound App", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete outbound application\n\nThis endpoint allows you to delete an outbound application." }, { "info": { "name": "Fetch Outbound App User Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/user/token", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Fetch outbound application user token\n\nThis endpoint allows you to fetch the user token for an outbound application." }, { "info": { "name": "Fetch Latest Outbound App User Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/user/token/latest", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Fetch latest outbound application user token\n\nThis endpoint allows you to fetch the latest user token for an outbound application." }, { "info": { "name": "Fetch Outbound App Tenant Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/tenant/token", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Fetch outbound application tenant token\n\nThis endpoint allows you to fetch the tenant token for an outbound application." }, { "info": { "name": "Create outbound application according to existing dcr preset", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/create/bydcrpreset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new outbound application according to existing dcr preset, using a valid management key." }, { "info": { "name": "Create outbound application by existing template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/create/bytemplate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new outbound application by existing template using a valid management key." }, { "info": { "name": "Fetch Latest Outbound App Tenant Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/tenant/token/latest", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Fetch latest outbound application tenant token\n\nThis endpoint allows you to fetch the latest tenant token for an outbound application." }, { "info": { "name": "Connect to outbound application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/connect", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Connect to outbound application, using a valid JWT." }, { "info": { "name": "Delete outbound application token by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/outbound/token", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete outbound application token by id, using a valid management key." }, { "info": { "name": "Delete outbound application tokens by appId or userId", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/outbound/user/tokens", "params": [ { "name": "appId", "value": "", "type": "query" }, { "name": "userId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete outbound application tokens by appId or userId, using a valid management key." }, { "info": { "name": "Upload user API key for outbound app", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/user/apikey/upload", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload/set a static API key for a user on an apikey-type outbound application, using a valid management key." }, { "info": { "name": "Upload tenant API key for outbound app", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/outbound/app/tenant/apikey/upload", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload/set a static API key for a tenant on an apikey-type outbound application, using a valid management key." }, { "info": { "name": "Get Tenant Password Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/password/settings", "params": [ { "name": "tenantId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get password settings for a tenant\n\nThis endpoint allows you to get the password settings of a given tenant.\n\n### See Also\n- See [tenant password settings](/customize/tenant#passwords) for details about tenant password settings." }, { "info": { "name": "Update Tenant Password Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/password/settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update password settings for a tenant\n\nThis endpoint allows you to update the password settings of a given tenant.\n\n### See Also\n- See [tenant password settings](/customize/tenant#passwords) for details about tenant password settings." }, { "info": { "name": "Load All Permission", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/permission/all", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all permissions, using a valid management key.\n\nThis API endpoint returns details all permissions configured within the Descope instance. The response includes an array of permissions and these details of each permission:\n- name\n- description\n- systemDefault\n\n### Next Steps\n\nOnce you have this data, you can utilize the response to [Create Roles](/api/management/roles/create-role) or [Update Roles](/api/management/roles/update-role)\n\n### See also\n\n- See [User Authorization](/manage/roles" }, { "info": { "name": "Create Permission", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/permission/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create a permission, using a valid management key.\n\nThis API endpoint allows administrators to create a new permission. The endpoint takes the following two parameters:\n- name (required)\n- description (optional)\n\n### Next Steps\n\nOnce 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)\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles a" }, { "info": { "name": "Update Permission", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/permission/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update a permission, using a valid management key.\n\nThis API endpoint allows administrators to update an existing permission. The endpoint takes the following two parameters:\n- name (required)\n- description (optional - though if not provided, it will be removed from the permission)\n\n### Next Steps\n\nOnce 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)\n\n### See also\n\n- See [User" }, { "info": { "name": "Delete Permission", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/permission/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a permission, using a valid management key.\n\nThis API endpoint allows administrators to delete an existing permission. The endpoint takes the following one parameter:\n- name (required)\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permissions." }, { "info": { "name": "Bulk Create Permissions", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/permission/create/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bulk create Permissions, using a valid management key." }, { "info": { "name": "Bulk Update Permissions", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/permission/update/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bulk update Permissions, using a valid management key." }, { "info": { "name": "Bulk Delete Permissions", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/permission/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bulk delete Permissions, using a valid management key." }, { "info": { "name": "Create resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new resource, using a valid management key." }, { "info": { "name": "Update resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a resource, using a valid management key." }, { "info": { "name": "Load resource by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/resource/load", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a resource by ID, using a valid management key." }, { "info": { "name": "Load resource by URI", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/resource/load/uri", "params": [ { "name": "uri", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a resource by URI, using a valid management key." }, { "info": { "name": "Delete resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a resource, using a valid management key." }, { "info": { "name": "Delete resources batch", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete multiple resources, using a valid management key." }, { "info": { "name": "Load all resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/resources/load", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load all resources, using a valid management key." }, { "info": { "name": "Create dynamic registration template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/dynamic-registration-template/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new dynamic registration template, using a valid management key." }, { "info": { "name": "Update dynamic registration template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/dynamic-registration-template/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing dynamic registration template, using a valid management key." }, { "info": { "name": "Load dynamic registration template", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/resource/dynamic-registration-template/load", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load a dynamic registration template by id, using a valid management key." }, { "info": { "name": "Delete dynamic registration template", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/dynamic-registration-template/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a dynamic registration template by id, using a valid management key." }, { "info": { "name": "Delete dynamic registration templates", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resource/dynamic-registration-templates/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete multiple dynamic registration templates by id, using a valid management key." }, { "info": { "name": "Load all dynamic registration templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/resource/dynamic-registration-templates/load", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load all dynamic registration templates, using a valid management key." }, { "info": { "name": "Create resource policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resourcepolicy/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new resource policy, using a valid management key." }, { "info": { "name": "Update resource policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resourcepolicy/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a resource policy, using a valid management key." }, { "info": { "name": "Delete resource policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resourcepolicy/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a resource policy, using a valid management key." }, { "info": { "name": "Load resource policies by app", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/resourcepolicy/app/load", "params": [ { "name": "thirdPartyApplicationId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load resource policies for a specific third party application, using a valid management key." }, { "info": { "name": "Batch create resource policies", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resourcepolicy/create/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create multiple resource policies, using a valid management key." }, { "info": { "name": "Batch delete resource policies", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/resourcepolicy/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete multiple resource policies, using a valid management key." }, { "info": { "name": "Load All Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/role/all", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all roles, using a valid management key.\n\nThis API endpoint allows administrators to load all existing roles.\n\nThis endpoint returns an array of roles including their name, description, and permissionsNames.\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permissions." }, { "info": { "name": "Search Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Search roles, using a valid management key.\n\nThis API endpoint allows administrators to search against existing roles.\n\nThis endpoint returns an array of roles including their name, description, and permissionsNames that match the search parameters.\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permissions." }, { "info": { "name": "Create Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create a role, using a valid management key.\n\nThis API endpoint allows administrators to create a new role. The endpoint takes the following three parameters:\n- name (required)\n- description (optional)\n- permissionNames (optional)\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permissions." }, { "info": { "name": "Update Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update an existing role, using a valid management key.\n\nThis API endpoint allows administrators to update an existing role. The endpoint takes the following four parameters:\n- name (required)\n- newName (required)\n- description (optional - though if not provided, it will be removed from the role))\n- permissionNames (optional - though if not provided, it will be removed from the role))\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permiss" }, { "info": { "name": "Delete Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a role, using a valid management key.\n\nThis API endpoint allows administrators to delete an existing role. The endpoint takes the following one parameter:\n- name (required)\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permissions._override/App.tsx" }, { "info": { "name": "Bulk Create Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/create/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bulk create Roles, using a valid management key." }, { "info": { "name": "Batch Delete Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete roles in batch, using a valid management key.\n\nThis API endpoint allows administrators to delete roles in batch. The endpoint takes the following one parameter:\n- roleNames (required)\n\n### See also\n\n- See [User Authorization](/manage/roles/) for further details on managing roles and permissions." }, { "info": { "name": "Bulk Update Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/role/update/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bulk update Roles, using a valid management key." }, { "info": { "name": "Create SSO WS-Fed IDP application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/wsfed/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new SSO WS-Fed IDP application, using a valid management key." }, { "info": { "name": "Load All Applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/sso/idp/apps/load", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all Applications within a project\n\nThis endpoint returns details of all Applications within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Load Application by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/load", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load Application by ID within a project\n\nThis endpoint returns details of a specific Application within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Update SSO WS-Fed IDP application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/wsfed/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a SSO WS-Fed IDP application, using a valid management key." }, { "info": { "name": "Create OIDC Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/oidc/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create OIDC Application within a project\n\nThis endpoint creates an OIDC Application within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Update OIDC Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/oidc/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update OIDC Application within a project\n\nThis endpoint updates an OIDC Application within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Create SAML Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/saml/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create SAML Application within a project\n\nThis endpoint creates a SAML Application within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Update SAML Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/saml/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update SAML Application within a project\n\nThis endpoint updates a SAML Application within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Delete Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/idp/app/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete an Application within a project\n\nThis endpoint deletes an Application within your Descope project.\n\n### See Also\n- Review our [documentation](/manage/idpapplications/) around Applications within Descope." }, { "info": { "name": "Get Tenant's SAML/OIDC Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v2/mgmt/sso/settings", "params": [ { "name": "tenantId", "value": "", "type": "query" }, { "name": "ssoId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get the current SAML/OIDC configuration settings of a tenant, using a valid management key.\n\nThis API endpoint allows you to get the current SAML/OIDC configuration settings of a tenant.\n\n### See also\n\n- See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant." }, { "info": { "name": "Load all SSO Settings for a tenant", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v2/mgmt/sso/settings/all", "params": [ { "name": "tenantId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Load all SSO Settings for a tenant, using a valid management key." }, { "info": { "name": "Configure SSO Redirect URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/redirect", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Configure tenant SSO Redirect URL, using a valid management key." }, { "info": { "name": "Set Tenant's SAML Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/saml", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Configure the SAML Settings, using a valid management key.\n\nThis API endpoint will configure the SAML settings on a tenant utilizing a valid management key.\n\nThis 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\"\n\nThis endpoint also accepts the attribute mapping you would like to be configured on the SAML settings.\n\nThese configurations will " }, { "info": { "name": "Set Tenant's SAML Settings via Metadata URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/saml/metadata", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Configure the SAML Metadata URL, using a valid management key.\n\nThis API endpoint will configure the SAML Metadata URL on a tenant utilizing a valid management key.\n\nThis 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\"\n\nThis endpoint also accepts the attribute mapping you would like to be configured on the SAML settings.\n\nThis Metadata URL c" }, { "info": { "name": "Set Tenant's OIDC Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/oidc", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Configure the OIDC settings of a tenant, using a valid management key.\n\nThis API endpoint will configure the OIDC settings on a tenant utilizing a valid management key.\n\nThis endpoint accepts the OIDC configuration settings as well as the attribute mapping you would like to be configured on the SAML settings.\n\n### See also\n\n- See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant." }, { "info": { "name": "Create New SSO Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/settings/new", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create new SSO settings for a tenant, using a valid management key.\n\nThis 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.\n\n### See also\n\n- See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant." }, { "info": { "name": "Delete Tenant's SAML/OIDC Settings", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/sso/settings", "params": [ { "name": "tenantId", "value": "", "type": "query" }, { "name": "ssoId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete the current SAML/OIDC configuration settings of a tenant, using a valid management key.\n\nThis API endpoint allows you to delete the current SAML/OIDC configuration settings of a tenant.\n\nUse this with caution as this endpoint deletes the configuration and is irreversible.\n\n### See also\n\n- See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant." }, { "info": { "name": "Recalculate SSO Mappings", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/recalculate-mappings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Recalculate SSO group to role mappings for all users in a tenant, using a valid management key." }, { "info": { "name": "Update SSO Provider IDs", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/sso/provider-ids", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update SSO provider IDs and SCIM provider IDs for tenant SSO settings. This endpoint is not publicly documented." }, { "info": { "name": "Load All Tenants", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/tenant/all", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load all tenants, using a valid management key.\n\nThis 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:\n- id\n- name\n- selfProvisioningDomains\n\n### Next Steps\n\n- 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)\n- You can also apply sso configura" }, { "info": { "name": "Load Tenant By ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/tenant", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Load tenant by ID, using a valid management key.\n\nThis 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:\n- id\n- name\n- selfProvisioningDomains\n\n### Next Steps\n\n- 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)\n- You can also a" }, { "info": { "name": "Search Tenants", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Search all tenants, using a valid management key.\n\nThis API endpoint returns details of configured tenants within the Descope instance that match the search parameters. The response includes an array of the tenants and these details for each tenant:\n- id\n- name\n- selfProvisioningDomains\n\n### Next Steps\n\n- 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)\n- Y" }, { "info": { "name": "Update Tenant Default Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/updateDefaultRoles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update tenant default roles, using a valid management key." }, { "info": { "name": "Create Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Create a new tenant, using a valid management key.\n\nThis API endpoint will create a new tenant utilizing a valid management key.\n\nCreation of a new tenant can set the name, id, and selfProvisioningDomains. The id and selfProvisioningDomains are not mandatory. The id will be autogenerated if not provided. The response will always include the tenantId.\n\n### Next Steps\n\n- You can then add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/u" }, { "info": { "name": "Update Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update a tenant, using a valid management key.\n\nThis 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.\n\n### Next Steps\n\n- You can then add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user)\n- You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement" }, { "info": { "name": "Delete Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete a tenant, using a valid management key.\n\nThis API endpoint will delete a tenant utilizing a valid management key based on the provided user tenandId.\n\n### See also\n\n- See [Tenant Management](/management/tenant-management) for further details on managing tenants." }, { "info": { "name": "Remove SSO User from Tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/sso-user-remove", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Remove an SSO user from a tenant, using a valid management key.\n\nThis API endpoint removes an SSO user's association with a tenant.\n\n### See also\n\n- See [Tenant Management](/management/tenant-management) for further details on managing tenants." }, { "info": { "name": "Authenticated SSO Admin Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/adminlinks/sso/authenticated", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Authenticated SSO admin link for a tenant, using a valid management key.\n\nThis API endpoint handles authenticated SSO admin link requests for a tenant." }, { "info": { "name": "Generate SSO Admin Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v2/mgmt/tenant/adminlinks/sso/generate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Generate an SSO admin link for a tenant, using a valid management key.\n\nThis API endpoint generates an SSO admin link that allows a tenant administrator to configure SSO settings." }, { "info": { "name": "Revoke SSO Admin Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/adminlinks/sso/revoke", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Revoke an SSO admin link for a tenant, using a valid management key.\n\nThis API endpoint revokes an existing SSO admin link for a tenant." }, { "info": { "name": "Send SSO Admin Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/adminlinks/sso/send", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Send an SSO admin link to a tenant administrator, using a valid management key.\n\nThis API endpoint sends an SSO admin link via email to the specified tenant administrator." }, { "info": { "name": "Generate Tenant Admin SSO Link (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/adminlinks/sso/generate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate tenant admin SSO configuration link, using a valid management key. Deprecated: use the v2 endpoint at /v2/mgmt/tenant/adminlinks/sso/generate instead." }, { "info": { "name": "Get Tenant Session Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/tenant/settings", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Get session settings for a tenant\n\nThis endpoint allows you to get the session settings of a given tenant.\n\n### See Also\n- See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings." }, { "info": { "name": "Update Tenant Session Settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tenant/settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Update session settings for a tenant\n\nThis endpoint allows you to update the session settings of a given tenant.\n\n### See Also\n- See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings." }, { "info": { "name": "Generate OTP", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tests/generate/otp", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Generate an OTP verification code for a test user.\n\nThis endpoint is used to generate an OTP verification code for a test user. You can define whether this is sent via email or sms.\n\nOnce 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)\n\n### See Also\n- See [OTP Authentication](/api/otp/) for details about implementing OTP.\n- See [Create a user](/api/management/users/create-user) with the `te" }, { "info": { "name": "Generate Magic Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tests/generate/magiclink", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Generate a Magic Link for a test user.\n\nThis endpoint is used to generate a Magic Link for a test user. You can define whether this is sent via email or sms.\n\nOnce you generate the Magic Link Token must be verified via [verify token](/api/magic-link/verification/verify-token)\n\n### See Also\n- See [Magic link Authentication](/api/magiclink/) for details about implementing magic links.\n- See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test " }, { "info": { "name": "Generate Enchanted Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/tests/generate/enchantedlink", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Generate a Enchanted Link for a test user.\n\nThis endpoint is used to generate a Enchanted Link for a test user. You can define whether this is sent via email or sms.\n\nOnce you generate the Enchanted Link Token must be verified via [verify token](/api/enchanted-link/verify-token)\n\n### See Also\n- See [Enchanted link Authentication](/api/enchantedlink/) for details about implementing enchanted links.\n- See [Create a user](/api/management/users/create-user) with the `test` flag set to true to se" }, { "info": { "name": "Delete All Test Users", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.descope.com/v1/mgmt/user/test/delete/all", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "### Delete all test users\n\nThis endpoint is used to delete all test users from a project. This action will delete these users forever and they will not be recoverable.\n\n### See Also\n- See [Manage Test Users](/manage/testusers/) for more information on test users." }, { "info": { "name": "Create third party application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new third party application, using a valid management key." }, { "info": { "name": "Update third party application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a third party application, using a valid management key." }, { "info": { "name": "Patch third party application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/patch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch a third party application, using a valid management key." }, { "info": { "name": "Load third party application by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/load", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "clientId", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Loads project third party application by id, using a valid management key." }, { "info": { "name": "Load All third party applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/thirdparty/apps/load", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Loads all project third party applications, using a valid management key." }, { "info": { "name": "Get third party application secret", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/secret", "params": [ { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a third party application secret, using a valid management key." }, { "info": { "name": "NoPublishRotate", "type": "http" }, "http": { "method": "GET", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/rotate" } }, { "info": { "name": "Rotate third party application secret by application ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/rotate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Rotate the project third party application secret by the application id, using a valid management key." }, { "info": { "name": "Search third party applications consents", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/consents/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search third party applications consents, using a valid management key." }, { "info": { "name": "Delete third party applications consents", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/consents/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete third party applications consents, using a valid management key." }, { "info": { "name": "Delete third party applications consents by tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/consents/delete/tenant", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete third party applications consents by tenant, using a valid management key." }, { "info": { "name": "Delete third party application", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a third party application, using a valid management key." }, { "info": { "name": "Batch delete third party applications", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/thirdparty/app/delete/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete multiple third party applications in batch, using a valid management key." }, { "info": { "name": "Generate a token for user sign up, later can be verified with magiclink", "type": "http" }, "http": { "method": "POST", "url": "https://api.descope.com/v1/mgmt/user/signup/embeddedlink", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a token for user sign up" } ] } ], "bundled": true }