openapi: 3.0.3 info: title: Descope Apps Mgmt API description: Descope API contact: name: Descope url: https://descope.com email: support@descope.com version: 0.0.1 servers: - url: https://api.descope.com description: Descope Production - url: '{customUrl}' description: Custom server URL variables: customUrl: default: https://api.descope.com description: Your Descope API base URL security: - Descope Project ID: [] Descope Project ID:Refresh JWT: [] Descope Project ID:Session JWT: [] Descope Project ID and Management Key: [] Descope Project ID:Access Key: [] tags: - name: Mgmt paths: /v1/mgmt/inboundapp/app/{projectId}/register: post: tags: - Mgmt description: Register Third Party Application according to RFC 7591 operationId: RegisterThirdPartyApplication parameters: - name: projectId in: path description: Auto fill by proto from the requested URL required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/managementv1.RegisterThirdPartyApplicationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managementv1.RegisterThirdPartyApplicationResponse' x-publishYaml: thirdPartyApps security: [] x-meta: title: undefined | Third Party Apps description: Register Third Party Application according to RFC 7591 keywords: api, third party apps /v1/mgmt/mcp/client/{projectId}/{mcpServerId}/register: post: tags: - Mgmt description: Register MCP Server client according to RFC 7591 operationId: RegisterMcpServerClient parameters: - name: projectId in: path description: Auto fill by proto from the requested URL required: true schema: type: string - name: mcpServerId in: path description: Auto fill by proto from the requested URL (only in agentic hub) required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/managementv1.RegisterThirdPartyApplicationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managementv1.RegisterThirdPartyApplicationResponse' x-publishYaml: thirdPartyApps security: [] x-meta: title: undefined | Third Party Apps description: Register MCP Server client according to RFC 7591 keywords: api, third party apps /v1/mgmt/accesskey: get: tags: - Mgmt summary: Load An Access Key description: '### Load an access key, using a valid management key. This API endpoint allows administrators to load the details of an existing access key. The response contains details of the access key including associated roles and tenants as well as details of the key''s creation, status, and expiration. ### Next Steps Once you have this data, you can utilize the response to [Update an access key](/api/management/access-keys/update-access-key), [Activate an access key](/api/management/access-keys/activate-access-key), [Deactivate an access key](/api/management/access-keys/deactivate-access-key), or [Delete an access key](/api/management/access-keys/delete-access-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: LoadAccessKey parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccessKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 1 x-meta: title: Load An Access Key | Access Key Management description: Load an access key, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/import: post: tags: - Mgmt summary: Import Access Key description: Import an access key by providing its plaintext value, using a valid management key. operationId: ImportAccessKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportAccessKeysRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImportAccessKeysResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 2 x-meta: title: Import Access Key | Access Key Management description: Import an access key by providing its plaintext value, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/search: post: tags: - Mgmt summary: Search Access Keys description: '### Search access keys, using a valid management key. This API endpoint allows administrators to search for details of existing access keys for a given array of tenants. The response contains an array of details for the access keys returned by the search including associated roles and tenants as well as details of the key''s creation, status, and expiration. ### Next Steps Once you have this data, you can utilize the response to [Update an access key](/api/management/access-keys/update-access-key), [Activate an access key](/api/management/access-keys/activate-access-key), [Deactivate an access key](/api/management/access-keys/deactivate-access-key), or [Delete an access key](/api/management/access-keys/delete-access-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: SearchAccessKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchAccessKeysRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccessKeysResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 2 x-meta: title: Search Access Keys | Access Key Management description: Search access keys, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/create: post: tags: - Mgmt summary: Create Access Key description: '### Create an access key, using a valid management key. This API endpoint allows administrators to create an access key. During the creation of the access key, you can set the name, expiration time, roles and tenant:role pairs to associated with the key. ### Next Steps Once you have the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: CreateAccessKey requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessKeyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAccessKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 3 x-meta: title: Create Access Key | Access Key Management description: Create an access key, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/update: post: tags: - Mgmt summary: Update Access Key description: '### Update an existing access key, using a valid management key. This API endpoint allows administrators to update an existing access key. With this endpoint, you can only update the access key''s name. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: UpdateAccessKey requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessKeyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccessKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 4 x-meta: title: Update Access Key | Access Key Management description: Update an existing access key, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/activate: post: tags: - Mgmt summary: Activate Access Key description: '### Activate an existing access key, using a valid management key. This API endpoint allows administrators to activate an existing access key. ### Next Steps Once you have reactivated the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: ActivateAccessKey requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 5 x-meta: title: Activate Access Key | Access Key Management description: Activate an existing access key, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/deactivate: post: tags: - Mgmt summary: Deactivate Access Key description: '### Deactivate an existing access key, using a valid management key. This API endpoint allows administrators to deactivate an existing access key. Once the access key has been deactivated, it''s access will be revoked until reactivated. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: DeactivateAccessKey requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 6 x-meta: title: Deactivate Access Key | Access Key Management description: Deactivate an existing access key, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/activate/batch: post: tags: - Mgmt summary: Batch Activate Access Keys description: '### Activate existing access keys in batch, using a valid management key. This API endpoint allows administrators to activate existing access keys in batch. ### Next Steps Once you have reactivated the access key, you can utilize it to configure external items such as [SCIM](/api/scimmanagement/), or use it to [exchange for a JWT](/api/access-keys/exchange-key). ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: ActivateAccessKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyBatchRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 7 x-meta: title: Batch Activate Access Keys | Access Key Management description: Activate existing access keys in batch, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/deactivate/batch: post: tags: - Mgmt summary: Batch Deactivate Access Keys description: '### Deactivate existing access keys in batch, using a valid management key. This API endpoint allows administrators to deactivate existing access keys in batch. Once the access keys have been deactivated, their access will be revoked until reactivated. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: DeactivateAccessKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyBatchRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 8 x-meta: title: Batch Deactivate Access Keys | Access Key Management description: Deactivate existing access keys in batch, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/delete/batch: post: tags: - Mgmt summary: Batch Delete Access Keys description: '### Delete existing access keys in batch, using a valid management key. This API endpoint allows administrators to delete existing access keys in batch. Once the access keys have been deleted, their access will be revoked. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: DeleteAccessKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyBatchRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 9 x-meta: title: Batch Delete Access Keys | Access Key Management description: Delete existing access keys in batch, using a valid management key. keywords: api, access key management /v1/mgmt/accesskey/delete: post: tags: - Mgmt summary: Delete Access Key description: '### Delete an existing access key, using a valid management key. This API endpoint allows administrators to delete an existing access key. Once the access key has been deleted, it''s access will be revoked. ### See also - See [Access Key Management](/access-keys) for further details on managing access keys.' operationId: DeleteAccessKey requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: accessKeyManagement x-order: 10 x-meta: title: Delete Access Key | Access Key Management description: Delete an existing access key, using a valid management key. keywords: api, access key management /v1/mgmt/audit/search: post: tags: - Mgmt summary: Search Audit description: '### Search the audit log, using a valid management key. This API endpoint allows you to search the audit log utilizing various search parameters and returns the results in JSON format.' operationId: SearchAudit requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchAuditRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchAuditResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: auditManagement x-order: 1 x-meta: title: Search Audit | Audit Management description: Search the audit log, using a valid management key. keywords: api, audit management /v1/mgmt/audit/event: post: tags: - Mgmt summary: Create Audit Event description: '### Create an audit log event, using a valid management key. This API endpoint allows you to create an audit log utilizing various parameters and returns the results in JSON format.' operationId: CreateAuditEvent requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAuditRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: auditManagement x-order: 2 x-meta: title: Create Audit Event | Audit Management description: Create an audit log event, using a valid management key. keywords: api, audit management /v1/mgmt/analytics/search: post: tags: - Mgmt summary: Search Analytics description: Search analytics (summarized) data grouped by time periods, using a valid management key. operationId: SearchAnalytics requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchAnalyticsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchAnalyticsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: auditManagement x-order: 3 x-meta: title: Search Analytics | Audit Management description: Search analytics (summarized) data grouped by time periods, using a valid management key. keywords: api, audit management /v1/mgmt/user: get: tags: - Mgmt summary: Load User description: '### Load a user''s data, using a valid management key. This 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. - loginIds - userId - name - email - phone - verified settings (phone, email) - Tenant configurations - which tenantIds, which roleNames _Note: Suppose you frequently load a user for a specific user detail, such as their email address or a particular custom attribute. In that case, you can save execution time and additional API/SDK calls to load the user by adding the items to the custom claim. For details on adding items to the custom claims, see [this documentation](/security-best-practices/custom-claims#using-custom-claims-within-descope-flows)._ _Note: If you have access to all federated applications, the list will return as an empty array. Descope allows you to restrict which apps each user has access to, but by default gives access to all applications._ ### Next Steps Once you have this data, you can utilize the response to prepare the payload to perform an [Update](/api/management/users/update-user) on the user. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: LoadUser parameters: - name: loginId in: query schema: type: string - name: userId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 1 x-meta: title: Load User | User Management description: Load a user's data, using a valid management key. keywords: api, user management /v1/mgmt/user/create/test: post: tags: - Mgmt summary: Create Test User description: Create a test user, using a valid management key. operationId: CreateTestUser requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 1 x-meta: title: Create Test User | User Management description: Create a test user, using a valid management key. keywords: api, user management /v1/mgmt/user/provider/token: get: tags: - Mgmt summary: Get User Provider Token description: '### Get an existing user''s provider token, using a valid management key. This API endpoint will loads the user''s access token generated by the OAuth/OIDC provider, using a valid management key. When querying for OAuth providers, this only applies when utilizing your own account with the provider and have selected `Manage tokens from provider` selected under the [social auth methods](https://app.descope.com/settings/authentication/social). ### Query Params - `loginId` - The loginId of the user you want to get the provider token for. - `provider` - The provider you want to get the token for. - `withRefreshToken (optional)` - set to true to also return the refresh token. - `forceRefresh (optional)` - set to true to force a refresh of the token. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Provider Options](/auth-methods/oauth#social-login-oauth-providers) for a the out of the box list of providers.' operationId: GetUserProviderToken parameters: - name: loginId in: query schema: type: string - name: provider in: query schema: type: string - name: withRefreshToken in: query schema: type: boolean - name: forceRefresh in: query schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserProviderTokenResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 2 x-meta: title: Get User Provider Token | User Management description: Get an existing user's provider token, using a valid management key. keywords: api, user management /v1/mgmt/users/load: post: tags: - Mgmt summary: Load Users description: Load users by their IDs, using a valid management key. operationId: LoadUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 2 x-meta: title: Load Users | User Management description: Load users by their IDs, using a valid management key. keywords: api, user management /v1/mgmt/user/search: post: tags: - Mgmt summary: Search Users description: Search users, using a valid management key. operationId: SearchUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsersResponse' deprecated: true security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 3 x-meta: title: Search Users | User Management description: Search users, using a valid management key. keywords: api, user management /v2/mgmt/user/search/test: post: tags: - Mgmt summary: Search test Users description: Search test users, using a valid management key. operationId: SearchTestUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 3 x-meta: title: Search test Users | User Management description: Search test users, using a valid management key. keywords: api, user management /v2/mgmt/user/search: post: tags: - Mgmt summary: Search Users description: '### Search for users, using a valid management key. This 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. The response will include the following details on all users within an array of objects: - loginIds - userId - name - email - phone - verified settings (phone, email) - Tenant configurations (tenantIds, roleNames) ### Next Steps You can then parse through the response in order to find any users which you may need to delete, update, etc. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: SearchUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 4 x-meta: title: Search Users | User Management description: Search for users, using a valid management key. keywords: api, user management /v1/mgmt/user/history: post: tags: - Mgmt summary: Get User's Login History description: '### Get an user''s login history, using a valid management key. This API endpoint will loads the user''s login history based on the user''s userId. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UsersAuthHistory requestBody: content: application/json: schema: type: object properties: {} required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsersAuthHistoryResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 5 x-meta: title: Get User's Login History | User Management description: Get an user's login history, using a valid management key. keywords: api, user management /v1/mgmt/user/patch/batch: patch: tags: - Mgmt summary: Patch Users Batch description: Patch users in batch, using a valid management key. operationId: PatchUserBatch requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchUserBatchRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PatchUserBatchResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 5.1 x-meta: title: Patch Users Batch | User Management description: Patch users in batch, using a valid management key. keywords: api, user management /v1/mgmt/user/create: post: tags: - Mgmt summary: Create User description: "### 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\": [\n \"Test\"\n ]\n},\n{\n \"tenantId\": \"T2Igau6dX1R6SkomtFCdBLrc3r67\",\n \"roleNames\": [\n \"Test\"\n ]\n}\n```\n\nAdditionally, you can create a user with multiple login IDs by passing an array of loginIds in string format within the `additionalIdentifiers` key.\n\n### Next Steps\n\nOnce the user is created, the user can then login utilizing any sign-in api supported. This will then switch the user from invited to active.\n\n### See also\n\n- See [Manage User](/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." operationId: CreateUser requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 6 x-meta: title: Create User | User Management description: Create a new user, using a valid management key. keywords: api, user management /v1/mgmt/user/create/batch: post: tags: - Mgmt summary: Batch Create Users description: "### 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 \"roleNames\": [\n \"Test\"\n ]\n},\n{\n \"tenantId\": \"T2Igau6dX1R6SkomtFCdBLrc3r67\",\n \"roleNames\": [\n \"Test\"\n ]\n}\n```\n\nAdditionally, you can create a user with multiple login IDs by passing an array of loginIds in string format within the `additionalIdentifiers` key.\n\nYou can also decide whether to invite the users, configure the inviteUrl, and whether to send invites via email or SMS.\n\nWhen importing with hashed passwords, see [this guide](/migrate/custom#importing-passwords) for further detailed configuration of password hash formats.\n\n### Next Steps\n\nOnce the user is created, the user can then login utilizing any sign-in api supported. This will then switch the user from invited to active.\n\n### See also\n\n- See [Manage User](/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." operationId: CreateUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateUsersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 7 x-meta: title: Batch Create Users | User Management description: Batch Create Users, using a valid management key. keywords: api, user management /v1/mgmt/user/update: post: tags: - Mgmt summary: Update User description: '### Updates a user''s details, using a valid management key. This API endpoint will update a user''s details of a user utilizing a valid management key. It is important to understand the update will take the configurations for the user provided and will overwrite all user settings. This means that if the user currently has email and phone, but the update only includes email, the phone and other non-provided configurations will be removed. This API endpoint will remove any details that are not provided. It is preferred to use other updates supported by the API, such as the following options: - [Update User Status](/api/management/users/update-user-status) - [Update User Email](/api/management/users/update-user-email) - [Update User Phone](/api/management/users/update-user-phone) - [Update User Display Name](/api/management/users/update-user-display-name) - [Update User Add Tenant](/api/management/users/update-user-add-tenant) - [Update User Remove Tenant](/api/management/users/update-user-remove-tenant) - [Update User Add Role](/api/management/users/update-user-add-roles) - [Update User Remove Role](/api/management/users/update-user-remove-roles) Additionally, you can update a user with multiple login IDs by passing an array of loginIds in string format within the `additionalIdentifiers` key. It is suggested to gather the current user configurations via [Load User](/api/management/users/load-user) in order to assist you in building the payload for this api endpoint. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UpdateUser requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 8 x-meta: title: Update User | User Management description: Updates a user's details, using a valid management key. keywords: api, user management /v1/mgmt/user/update/recovery/email: post: tags: - Mgmt summary: Update User Recovery Email description: Update user recovery email, using a valid management key. operationId: UpdateUserRecoveryEmail requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRecoveryEmailRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 8.1 x-meta: title: Update User Recovery Email | User Management Email description: Update user recovery email, using a valid management key. Email keywords: api, user management, email /v1/mgmt/user/update/recovery/phone: post: tags: - Mgmt summary: Update User Recovery Phone description: Update user recovery phone, using a valid management key. operationId: UpdateUserRecoveryPhone requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRecoveryPhoneRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 8.2 x-meta: title: Update User Recovery Phone | User Management description: Update user recovery phone, using a valid management key. keywords: api, user management /v1/mgmt/user/patch: patch: tags: - Mgmt summary: Patch User description: '### Patch a user''s details, using a valid management key. This API endpoint will patch a user''s details of a user utilizing a valid management key. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: PatchUser requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 9 x-meta: title: Patch User | User Management description: Patch a user's details, using a valid management key. keywords: api, user management /v1/mgmt/user/update/status: post: tags: - Mgmt summary: Update User Status description: '### Updates an existing user''s status, using a valid management key. This API endpoint allows you to update the user''s status granularly without updating all user details. Available statuses to utilize: - invited - enabled - disabled The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UpdateUserStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserStatusRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 10 x-meta: title: Update User Status | User Management description: Updates an existing user's status, using a valid management key. keywords: api, user management /v1/mgmt/user/update/impersonationConsent: post: tags: - Mgmt summary: Update User Impersonation Consent description: Update user impersonation consent, using a valid management key. This allows granting impersonation consent without requiring the user-facing consent flow. operationId: UpdateUserImpersonationConsent requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserImpersonationConsentRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 10.5 x-meta: title: Update User Impersonation Consent | User Management description: Update user impersonation consent, using a valid management key. This allows granting impersonation consent without requiring the user-facing consent flow. keywords: api, user management /v1/mgmt/user/update/email: post: tags: - Mgmt summary: Update User Email description: '### Updates an existing user''s email, using a valid management key. This API endpoint allows you to update the user''s email granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UpdateUserEmail requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserEmailRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 11 x-meta: title: Update User Email | User Management Email description: Updates an existing user's email, using a valid management key. Email keywords: api, user management, email /v1/mgmt/user/update/loginid: post: tags: - Mgmt summary: Update User Login ID description: '### Updates an existing user''s login ID, using a valid management key. This API endpoint allows you to update a user''s Login ID. If you''d like to remove a login ID, provide an empty string for the new login ID. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UpdateUserLoginID requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserLoginIDRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 12 x-meta: title: Update User Login ID | User Management description: Updates an existing user's login ID, using a valid management key. keywords: api, user management /v1/mgmt/user/update/phone: post: tags: - Mgmt summary: Update User Phone description: '### Updates an existing user''s phone number, using a valid management key. This API endpoint allows you to update the user''s phone number granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UpdateUserPhone requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserPhoneRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 13 x-meta: title: Update User Phone | User Management description: Updates an existing user's phone number, using a valid management key. keywords: api, user management /v1/mgmt/user/update/name: post: tags: - Mgmt summary: Update User Display Name description: '### Updates an existing user''s display name, using a valid management key. This API endpoint allows you to update the user''s display name granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: UpdateUserDisplayName requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserDisplayNameRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 14 x-meta: title: Update User Display Name | User Management description: Updates an existing user's display name, using a valid management key. keywords: api, user management /v1/mgmt/user/update/role/add: post: tags: - Mgmt summary: Update User Add Roles description: Add roles to a user, using a valid management key. operationId: UpdateUserAddRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 14 x-meta: title: Update User Add Roles | User Management description: Add roles to a user, using a valid management key. keywords: api, user management /v1/mgmt/user/update/picture: post: tags: - Mgmt summary: Update User Picture description: '### Update an existing user''s profile picture, using a valid management key. This API endpoint allows you to update a user''s profile picture granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.' operationId: UpdateUserPicture requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserPictureRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 15 x-meta: title: Update User Picture | User Management description: Update an existing user's profile picture, using a valid management key. keywords: api, user management /v1/mgmt/user/update/customAttribute: post: tags: - Mgmt summary: Update User Custom Attribute description: '### Update an existing user''s custom attributes, using a valid management key. This API endpoint allows you to update a user''s custom attributes granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.' operationId: UpdateUserCustomAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserCustomAttributeRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 16 x-meta: title: Update User Custom Attribute | User Management description: Update an existing user's custom attributes, using a valid management key. keywords: api, user management /v1/mgmt/jwt/update: post: tags: - Mgmt summary: Update JWT description: '### Updates a JWT with custom claims, using a valid management key. This API endpoint will update a JWT with custom claims. This endpoint takes the JWT as well as the `customClaims` json.' operationId: UpdateJWT requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJWTRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managementv1.JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 17 x-meta: title: Update JWT | User Management description: Updates a JWT with custom claims, using a valid management key. keywords: api, user management /v2/mgmt/user/history: post: tags: - Mgmt summary: Users Authentication History V2 description: Load users' authentication history by user IDs, using a valid management key. V2 endpoint with improved request body handling. operationId: UsersAuthHistoryV2 requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersAuthHistoryRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsersAuthHistoryResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 17 x-meta: title: Users Authentication History V2 | User Management description: Load users' authentication history by user IDs, using a valid management key. V2 endpoint with improved request body handling. keywords: api, user management /v1/mgmt/user/password/expire: post: tags: - Mgmt summary: Expire User Passwsord description: '### Expire an existing user''s password, using a valid management key. This API endpoint allows you to expire an existing user''s password. Upon next login, the user will need to follow the reset password flow. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants. - See [Reset Password](/api/passwords/email/password-reset) for sending the password reset email.' operationId: ExpireUserPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/ExpireUserPasswordRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 18 x-meta: title: Expire User Passwsord | User Management description: Expire an existing user's password, using a valid management key. keywords: api, user management /v1/mgmt/user/trusteddevices/list: post: tags: - Mgmt summary: List Trusted Devices description: List trusted devices for one or more users. operationId: ListTrustedDevicesForUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/ListTrustedDevicesForUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListTrustedDevicesForUsersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 18 x-meta: title: List Trusted Devices | User Management description: List trusted devices for one or more users. keywords: api, user management /v1/mgmt/user/passkey/delete: post: tags: - Mgmt summary: Remove User Passkey description: Remove a specific passkey for a user by credential ID, using a valid management key. operationId: RemoveUserPasskey requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveUserPasskeyRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 19 x-meta: title: Remove User Passkey | User Management description: Remove a specific passkey for a user by credential ID, using a valid management key. keywords: api, user management /v1/mgmt/user/passkeys/import: post: tags: - Mgmt summary: Import User Passkeys description: Import passkey credentials for a user, using a valid management key. operationId: ImportUserPasskeys requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportUserPasskeysRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 19 x-meta: title: Import User Passkeys | User Management description: Import passkey credentials for a user, using a valid management key. keywords: api, user management /v1/mgmt/user/passkeys/list: post: tags: - Mgmt summary: List User Passkeys description: List all passkeys for a user, using a valid management key. operationId: ListUserPasskeys requestBody: content: application/json: schema: $ref: '#/components/schemas/ListUserPasskeysRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListUserPasskeysResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 19 x-meta: title: List User Passkeys | User Management description: List all passkeys for a user, using a valid management key. keywords: api, user management /v1/mgmt/user/password/set/active: post: tags: - Mgmt summary: Set Active Password for User description: '### Set an active password for an existing user, using a valid management key. This API endpoint allows you to set an active password for an existing user. This will allow the user to authenticate with this password without changing it. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.' operationId: SetUserActivePassword requestBody: content: application/json: schema: $ref: '#/components/schemas/SetUserPasswordRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SetUserPasswordResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 19 x-meta: title: Set Active Password for User | User Management description: Set an active password for an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/trusteddevices/remove: post: tags: - Mgmt summary: Delete Trusted Devices description: Delete user trusted devices by IDs. operationId: UpdateUserRemoveTrustedDevices requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRemoveTrustedDevicesRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 19 x-meta: title: Delete Trusted Devices | User Management description: Delete user trusted devices by IDs. keywords: api, user management /v1/mgmt/user/password/set/temporary: post: tags: - Mgmt summary: Set Temporary Password for User description: '### Set a temporary password for an existing user, using a valid management key. This API endpoint allows you to set a temporary password for an existing user. This will require the user to change their password on next authentication. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.' operationId: SetUserTemporaryPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/SetUserPasswordRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SetUserPasswordResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 20 x-meta: title: Set Temporary Password for User | User Management description: Set a temporary password for an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/totp/delete: post: tags: - Mgmt summary: Delete User's TOTP Seed description: '### Delete an existing user''s TOTP, using a valid management key. This API endpoint allows you to delete an existing user''s TOTP seed. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: RemoveUserTOTP requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveUserTOTPRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 21 x-meta: title: Delete User's TOTP Seed | User Management description: Delete an existing user's TOTP, using a valid management key. keywords: api, user management /v1/mgmt/user/update/tenant/add: post: tags: - Mgmt summary: Update User Add Tenant description: '### Add a tenant to an existing user, using a valid management key. This API endpoint allows you to add a user to a tenant granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.' operationId: UpdateUserAddTenant requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserTenantRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 22 x-meta: title: Update User Add Tenant | User Management description: Add a tenant to an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/update/tenant/remove: post: tags: - Mgmt summary: Update User Remove Tenant description: '### Removes a tenant from an existing user, using a valid management key. This API endpoint allows you to remove a user from a tenant granularly without updating all user details. The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Tenants](/management/tenant-management) for further details on managing tenants.' operationId: UpdateUserRemoveTenant requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserTenantRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 23 x-meta: title: Update User Remove Tenant | User Management description: Removes a tenant from an existing user, using a valid management key. keywords: api, user management /v2/mgmt/user/update/role/add: post: tags: - Mgmt summary: Update User Add Roles description: '### Add roles to an existing user, using a valid management key. This API endpoint allows you to add roles to a user granularly without updating all user details. `roleNames` is an array of the role names in string format. The `tenantId` is optional; if provided, the user must be a member of that tenant The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.' operationId: UpdateUserAddRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 24 x-meta: title: Update User Add Roles | User Management description: Add roles to an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/update/role/set: post: tags: - Mgmt summary: Set User's Roles description: '### Set an existing user''s roles, using a valid management key. This API endpoint allows you to set a user''s roles. This will override the current roles associated to the user and will set all passed roles. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.' operationId: UpdateUserSetRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 25 x-meta: title: Set User's Roles | User Management description: Set an existing user's roles, using a valid management key. keywords: api, user management /v1/mgmt/user/update/role/remove: post: tags: - Mgmt summary: Update User Remove Roles description: '### Remove roles from an existing user, using a valid management key. This API endpoint allows you to remove roles from a user granularly without updating all user details. `roleNames` is an array of the role names in string format. The `tenantId` is optional; if provided, the user must be a member of that tenant The response returns the user''s details in json format. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.' operationId: UpdateUserRemoveRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 26 x-meta: title: Update User Remove Roles | User Management description: Remove roles from an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/update/ssoapp/add: post: tags: - Mgmt summary: Add Application to User description: '### Add Applications to an existing user, using a valid management key. This API endpoint allows you to add Applications to a user granularly without updating all user details. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Applications](/manage/idpapplications/) for further details on Applications.' operationId: UpdateUserAddSSOApps requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserSSOAppsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 27 x-meta: title: Add Application to User | User Management description: Add Applications to an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/update/ssoapp/set: post: tags: - Mgmt summary: Set Applications to User description: '### Set Applications for an existing user, using a valid management key. This API endpoint allows you to set the associated Applications for a user. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Applications](/manage/idpapplications/) for further details on Applications.' operationId: UpdateUserSetSSOApps requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserSSOAppsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 28 x-meta: title: Set Applications to User | User Management description: Set Applications for an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/update/ssoapp/remove: post: tags: - Mgmt summary: Remove Application to User description: '### Remove Applications from an existing user, using a valid management key. This API endpoint allows you to remove Applications from a user granularly without updating all user details. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Applications](/manage/idpapplications/) for further details on Applications.' operationId: UpdateUserRemoveSSOApps requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserSSOAppsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 29 x-meta: title: Remove Application to User | User Management description: Remove Applications from an existing user, using a valid management key. keywords: api, user management /v1/mgmt/user/logout: post: tags: - Mgmt summary: Log user out of all sessions description: '### Log a user out of all sessions, using a valid management key. This API endpoint allows you to log a user out of all active sessions. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. - See [Manage Roles](/manage/roles/) for further details on managing roles.' operationId: LogoutAllUserDevices requestBody: content: application/json: schema: $ref: '#/components/schemas/UserLogoutRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 30 x-meta: title: Log user out of all sessions | User Management description: Log a user out of all sessions, using a valid management key. keywords: api, user management /v1/mgmt/user/passkeys/delete: post: tags: - Mgmt summary: Delete User's Passkeys description: '### Delete a user''s Passkeys, using a valid management key. This API endpoint will delete all existing passkeys for the user ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: RemoveUserPasskeys requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveUserPasskeysRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 31 x-meta: title: Delete User's Passkeys | User Management description: Delete a user's Passkeys, using a valid management key. keywords: api, user management /v1/mgmt/user/delete: post: tags: - Mgmt summary: Delete User description: '### Delete a user, using a valid management key. This API endpoint will delete a user utilizing a valid management key based on the provided user loginId. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: DeleteUser requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteUserRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 32 x-meta: title: Delete User | User Management description: Delete a user, using a valid management key. keywords: api, user management /v1/mgmt/user/delete/batch: post: tags: - Mgmt summary: Batch Delete Users description: '### Delete users, using a valid management key. This API endpoint will delete users utilizing a valid management key. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object.' operationId: DeleteUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteUsersRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 33 x-meta: title: Batch Delete Users | User Management description: Delete users, using a valid management key. keywords: api, user management /v1/mgmt/impersonate: post: tags: - Mgmt summary: Impersonate User description: '### Impersonate a user, using a valid management key. This API endpoint will allow you to impersonate a user using a login ID. The impersonator user must have the impersonation permission in order for this request to work. The response would be a refresh JWT of the impersonated user' operationId: Impersonate requestBody: content: application/json: schema: $ref: '#/components/schemas/ImpersonateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managementv1.JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 34 x-meta: title: Impersonate User | User Management description: Impersonate a user, using a valid management key. keywords: api, user management /v1/mgmt/auth/anonymous: post: tags: - Mgmt summary: Anonymous User description: '### Anonymous User Anonymous Users are identified with a unique Descope JWT type. Eventually, create a token that we can use as the defined anonymous identity. Signed by Descope. For more info, please refer to our anonymous users documentation.' operationId: Anonymous requestBody: content: application/json: schema: $ref: '#/components/schemas/AnonymousUserRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AnonymousJWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-order: 35 x-meta: title: Anonymous User | User Management description: Anonymous User keywords: api, user management /v1/mgmt/impersonate/stepup: post: tags: - Mgmt summary: Impersonate Stepup description: Impersonate as a different user with step-up claim operationId: ImpersonateStepup requestBody: content: application/json: schema: $ref: '#/components/schemas/ImpersonateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managementv1.JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-meta: title: Impersonate Stepup | User Management description: Impersonate as a different user with step-up claim keywords: api, user management /v1/mgmt/stop/impersonation: post: tags: - Mgmt summary: Stop Impersonation description: Stop impersonation as a different user operationId: StopImpersonation requestBody: content: application/json: schema: $ref: '#/components/schemas/StopImpersonationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managementv1.JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: userManagement x-meta: title: Stop Impersonation | User Management description: Stop impersonation as a different user keywords: api, user management /v1/mgmt/auth/signin: post: tags: - Mgmt summary: Generate JWT for Sign-In description: Generate a JWT for an existing user, using a valid management key. operationId: GenerateJWTSignIn requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateJWTSignInRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: generice x-order: 1 x-meta: title: Generate JWT for Sign-In | Generice description: Generate a JWT for an existing user, using a valid management key. keywords: api, generice /v1/mgmt/auth/signup: post: tags: - Mgmt summary: Generate JWT for Sign-Up description: Create a new user and generate a JWT for them, using a valid management key. operationId: GenerateJWTSignUp requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateJWTSignUpRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: generic x-order: 3 x-meta: title: Generate JWT for Sign-Up | Generic description: Create a new user and generate a JWT for them, using a valid management key. keywords: api, generic /v1/mgmt/auth/signup-in: post: tags: - Mgmt summary: Generate JWT for Sign-Up or Sign-In description: 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. operationId: GenerateJWTSignUpOrIn requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateJWTSignUpRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JWTResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: generic x-order: 3 x-meta: title: Generate JWT for Sign-Up or Sign-In | Generic description: 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. keywords: api, generic /v1/mgmt/authz/schema/save: post: tags: - Mgmt summary: Save an authz schema description: Save (create or update) an authz schema for your project. operationId: SaveSchema requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveSchemaRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaveSchemaResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 1 x-meta: title: Save an authz schema | Authz description: Save (create or update) an authz schema for your project. keywords: api, authz /v1/mgmt/authz/schema/delete: post: tags: - Mgmt summary: Delete an authz schema description: Delete an authz schema thus removing authz from your project. operationId: DeleteSchema requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteSchemaRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteSchemaResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 2 x-meta: title: Delete an authz schema | Authz description: Delete an authz schema thus removing authz from your project. keywords: api, authz /v1/mgmt/authz/schema/load: post: tags: - Mgmt summary: Load an authz schema description: Load an authz schema for your project. operationId: LoadSchema requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadSchemaRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadSchemaResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 3 x-meta: title: Load an authz schema | Authz description: Load an authz schema for your project. keywords: api, authz /v1/mgmt/authz/ns/save: post: tags: - Mgmt summary: Save an authz namespace description: Save (create or update) an authz namespace for your project. operationId: SaveNamespace requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveNamespaceRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaveNamespaceResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 4 x-meta: title: Save an authz namespace | Authz description: Save (create or update) an authz namespace for your project. keywords: api, authz /v1/mgmt/fga/schema/dryrun: post: tags: - Mgmt summary: Validate an authz schema and preview the changes description: Preview schema diff between existing and new schema, without saving it. operationId: DryRunSchema requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveDSLSchemaRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaveSchemaDryRunResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: authz x-order: 4 x-meta: title: Validate an authz schema and preview the changes | Authz description: Preview schema diff between existing and new schema, without saving it. keywords: api, authz /v1/mgmt/authz/ns/delete: post: tags: - Mgmt summary: Delete an authz namespace description: Delete an authz namespace and remove all related relations. operationId: DeleteNamespace requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteNamespaceRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteNamespaceResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 5 x-meta: title: Delete an authz namespace | Authz description: Delete an authz namespace and remove all related relations. keywords: api, authz /v1/mgmt/authz/rd/save: post: tags: - Mgmt summary: Save an authz relation definition description: Save (create or update) an authz relation definition for your project. operationId: SaveRelationDefinition requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveRelationDefinitionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaveRelationDefinitionResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 6 x-meta: title: Save an authz relation definition | Authz description: Save (create or update) an authz relation definition for your project. keywords: api, authz /v1/mgmt/authz/rd/delete: post: tags: - Mgmt summary: Delete an authz relation definition description: Delete an authz relation definition for your project and remove all related relations. operationId: DeleteRelationDefinition requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRelationDefinitionRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteRelationDefinitionResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 7 x-meta: title: Delete an authz relation definition | Authz description: Delete an authz relation definition for your project and remove all related relations. keywords: api, authz /v1/mgmt/authz/re/create: post: tags: - Mgmt summary: Create a list of authz relations description: Create a list of authz relations. operationId: CreateRelations requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRelationsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateRelationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 8 x-meta: title: Create a list of authz relations | Authz description: Create a list of authz relations. keywords: api, authz /v1/mgmt/authz/re/delete: post: tags: - Mgmt summary: Delete a list of authz relations description: Delete a list of authz relations. operationId: DeleteRelations requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRelationsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteRelationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 9 x-meta: title: Delete a list of authz relations | Authz description: Delete a list of authz relations. keywords: api, authz /v1/mgmt/authz/re/deleteresources: post: tags: - Mgmt summary: Delete all relations for a list of resources description: Delete all relations for the given list of resources. operationId: DeleteRelationsForResources requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRelationsForResourcesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteRelationsForResourcesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 10 x-meta: title: Delete all relations for a list of resources | Authz description: Delete all relations for the given list of resources. keywords: api, authz /v1/mgmt/authz/re/deleteresourcesrelations: post: tags: - Mgmt summary: Delete all relations with matching resourceIds for a list of resources description: Delete all relations for the given list of resources in which they are the resource. operationId: DeleteResourceRelationsForResources requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteResourceRelationsForResourcesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteResourceRelationsForResourcesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: authz x-order: 10 x-meta: title: Delete all relations with matching resourceIds for a list of resources | Authz description: Delete all relations for the given list of resources in which they are the resource. keywords: api, authz /v1/mgmt/authz/re/has: post: tags: - Mgmt summary: Check a list of relation queries description: Check a list of relation queries. operationId: HasRelations requestBody: content: application/json: schema: $ref: '#/components/schemas/HasRelationsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/HasRelationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 11 x-meta: title: Check a list of relation queries | Authz description: Check a list of relation queries. keywords: api, authz /v1/mgmt/authz/re/who: post: tags: - Mgmt summary: Query who can access resource with relation description: Return a list of users who can access a given resource with given relation. operationId: WhoCanAccess requestBody: content: application/json: schema: $ref: '#/components/schemas/WhoCanAccessRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WhoCanAccessResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 12 x-meta: title: Query who can access resource with relation | Authz description: Return a list of users who can access a given resource with given relation. keywords: api, authz /v1/mgmt/authz/re/resource: post: tags: - Mgmt summary: Load a list of defined relations for the given resource description: Load a list of defined relations for the given resource. operationId: ResourceRelations requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceRelationsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceRelationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 13 x-meta: title: Load a list of defined relations for the given resource | Authz description: Load a list of defined relations for the given resource. keywords: api, authz /v1/mgmt/authz/re/targets: post: tags: - Mgmt summary: Load a list of defined relations for the given list of targets description: Load a list of defined relations for the given list of targets without recursively traversing the relation tree. operationId: TargetsRelations requestBody: content: application/json: schema: $ref: '#/components/schemas/TargetsRelationsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TargetsRelationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 14 x-meta: title: Load a list of defined relations for the given list of targets | Authz description: Load a list of defined relations for the given list of targets without recursively traversing the relation tree. keywords: api, authz /v1/mgmt/authz/re/targetall: post: tags: - Mgmt summary: Load a list of relations for the given target including all derived relations description: Load a list of relations for the given target including all derived relations. operationId: WhatCanTargetAccess requestBody: content: application/json: schema: $ref: '#/components/schemas/WhatCanTargetAccessRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WhatCanTargetAccessResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 15 x-meta: title: Load a list of relations for the given target including all derived relations | Authz description: Load a list of relations for the given target including all derived relations. keywords: api, authz /v1/mgmt/authz/re/targetwithrelation: post: tags: - Mgmt summary: Load the resources that the target has the given relation to including all derived relationss description: Load the resources that the target has the given relation to including all derived relations operationId: WhatCanTargetAccessWithRelation requestBody: content: application/json: schema: $ref: '#/components/schemas/WhatCanTargetAccessWithRelationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WhatCanTargetAccessWithRelationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: authz x-order: 15 x-meta: title: Load the resources that the target has the given relation to including all derived relationss | Authz description: Load the resources that the target has the given relation to including all derived relations keywords: api, authz /v1/mgmt/authz/getmodified: post: tags: - Mgmt summary: Return the list of targets and resources changed since the given date description: Return the list of targets and resources changed since the given date. Should be used to invalidate local caches. operationId: GetModified requestBody: content: application/json: schema: $ref: '#/components/schemas/GetModifiedRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetModifiedResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 16 x-meta: title: Return the list of targets and resources changed since the given date | Authz description: Return the list of targets and resources changed since the given date. Should be used to invalidate local caches. keywords: api, authz /v1/mgmt/descoper: get: tags: - Mgmt summary: Get Descoper description: Get a descoper operationId: GetDescoper parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetDescoperResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: descopers x-order: 2 x-meta: title: Get Descoper | Descopers description: Get a descoper keywords: api, descopers put: tags: - Mgmt summary: Create Descoper description: Create a descoper operationId: CreateDescopers requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDescopersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDescopersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: descopers x-order: 1 x-meta: title: Create Descoper | Descopers description: Create a descoper keywords: api, descopers delete: tags: - Mgmt summary: Delete Descoper description: Delete a descoper operationId: DeleteDescoper parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteDescoperResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: descopers x-order: 4 x-meta: title: Delete Descoper | Descopers description: Delete a descoper keywords: api, descopers patch: tags: - Mgmt summary: Update Descoper description: Update a descoper operationId: UpdateDescoper requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDescoperRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateDescoperResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: descopers x-order: 3 x-meta: title: Update Descoper | Descopers description: Update a descoper keywords: api, descopers /v1/mgmt/descoper/list: post: tags: - Mgmt summary: List Descopers description: List descopers operationId: ListDescopers requestBody: content: application/json: schema: $ref: '#/components/schemas/ListDescopersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDescopersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: descopers x-order: 5 x-meta: title: List Descopers | Descopers description: List descopers keywords: api, descopers /v1/mgmt/fga/check: post: tags: - Mgmt summary: Check FGA Permission description: '### Check FGA permission This endpoint allows you to check if a target has a specific relation to a resource using Fine-Grained Authorization.' operationId: Check requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 1 x-meta: title: Check FGA Permission | Fga description: Check FGA permission keywords: api, fga /v1/mgmt/fga/relations: post: tags: - Mgmt summary: Get FGA Relations description: '### Get FGA relations This endpoint allows you to retrieve relations for a given target or resource using Fine-Grained Authorization.' operationId: CreateFGARelations requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTuplesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateTuplesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 2 x-meta: title: Get FGA Relations | Fga description: Get FGA relations keywords: api, fga delete: tags: - Mgmt summary: Delete All FGA Relations description: Delete all project FGA relations operationId: DeleteAllFGARelations responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteAllTuplesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 3 x-meta: title: Delete All FGA Relations | Fga description: Delete all project FGA relations keywords: api, fga /v1/mgmt/fga/mappable/resources: post: tags: - Mgmt summary: Search for FGA mappable resources description: Search for FGA mappable resources. operationId: SearchFGAMappableResources requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchFGAMappableResourcesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchMappableResourcesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 3 x-meta: title: Search for FGA mappable resources | Fga description: Search for FGA mappable resources. keywords: api, fga get: x-order: 6 x-publishYaml: fga summary: Get Mappable Resources description: '### Get mappable resources This endpoint allows you to retrieve mappable resources for Fine-Grained Authorization.' x-meta: title: Get Mappable Resources | Fga description: Get mappable resources keywords: api, fga tags: - Mgmt /v1/mgmt/fga/relations/delete: post: tags: - Mgmt summary: Delete FGA Relations description: '### Delete FGA relations This endpoint allows you to delete relations using Fine-Grained Authorization.' operationId: DeleteFGARelations requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteTuplesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteTuplesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 3 x-meta: title: Delete FGA Relations | Fga description: Delete FGA relations keywords: api, fga /v1/mgmt/fga/schema: get: tags: - Mgmt summary: Get FGA Schema description: '### Get FGA schema This endpoint allows you to retrieve the current Fine-Grained Authorization schema for your project.' operationId: GetFGASchema responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadDSLSchemaResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 4 x-meta: title: Get FGA Schema | Fga description: Get FGA schema keywords: api, fga post: tags: - Mgmt summary: Save FGA Schema description: '### Save FGA schema This endpoint allows you to save (create or update) the Fine-Grained Authorization schema for your project.' operationId: CreateFGASchema requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveDSLSchemaRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaveDSLSchemaResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 5 x-meta: title: Save FGA Schema | Fga description: Save FGA schema keywords: api, fga /v1/mgmt/fga/mappable/schema: get: tags: - Mgmt summary: Get Mappable Schema description: '### Get mappable schema This endpoint allows you to retrieve the mappable schema for Fine-Grained Authorization.' operationId: GetFGAMappableSchema parameters: - name: tenantId in: query schema: type: string - name: resourcesLimit in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetMappableSchemaResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 7 x-meta: title: Get Mappable Schema | Fga description: Get mappable schema keywords: api, fga /v1/mgmt/fga/resources/load: post: tags: - Mgmt summary: Load FGA Resources description: '### Load FGA resources This endpoint allows you to load resources for Fine-Grained Authorization.' operationId: LoadResourcesDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadResourcesDetailsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadResourcesDetailsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 8 x-meta: title: Load FGA Resources | Fga description: Load FGA resources keywords: api, fga /v1/mgmt/fga/resources/save: post: tags: - Mgmt summary: Save FGA Resources description: '### Save FGA resources This endpoint allows you to save resources for Fine-Grained Authorization.' operationId: SaveResourcesDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveResourcesDetailsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaveResourcesDetailsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-order: 9 x-meta: title: Save FGA Resources | Fga description: Save FGA resources keywords: api, fga /v1/mgmt/fga/backup: post: tags: - Mgmt summary: Create FGA Backup description: Create a new FGA backup. operationId: CreateFGABackup requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackupRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateBackupResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-meta: title: Create FGA Backup | Fga description: Create a new FGA backup. keywords: api, fga /v1/mgmt/fga/backup/{backupId}: get: tags: - Mgmt summary: Get FGA Backup description: Get an FGA backup by ID. operationId: GetFGABackup parameters: - name: backupId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetBackupResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-meta: title: Get FGA Backup | Fga description: Get an FGA backup by ID. keywords: api, fga delete: tags: - Mgmt summary: Delete FGA Backup description: Delete an FGA backup. operationId: DeleteFGABackup parameters: - name: backupId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteBackupResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-meta: title: Delete FGA Backup | Fga description: Delete an FGA backup. keywords: api, fga /v1/mgmt/fga/backup/{backupId}/restore: post: tags: - Mgmt summary: Restore FGA Backup description: Restore from an FGA backup. operationId: RestoreFGABackup parameters: - name: backupId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreBackupRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestoreBackupResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-meta: title: Restore FGA Backup | Fga description: Restore from an FGA backup. keywords: api, fga /v1/mgmt/fga/backups: get: tags: - Mgmt summary: List FGA Backups description: List all FGA backups. operationId: ListFGABackups responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListBackupsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: fga x-meta: title: List FGA Backups | Fga description: List all FGA backups. keywords: api, fga /v1/mgmt/flow/async/result: post: tags: - Mgmt summary: Get Management Flow async result description: Get the result from an async management flow execution (if any), using a valid management key. operationId: GetManagementFlowAsyncResult requestBody: content: application/json: schema: $ref: '#/components/schemas/GetManagementFlowAsyncResultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunManagementFlowResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 1 x-meta: title: Get Management Flow async result | Flow Management description: Get the result from an async management flow execution (if any), using a valid management key. keywords: api, flow management /v1/mgmt/flow/async/run: post: tags: - Mgmt summary: Run Management Flow asynchronously description: Run a management flow asynchronously, using a valid management key. operationId: RunManagementFlowAsync requestBody: content: application/json: schema: $ref: '#/components/schemas/RunManagementFlowRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunManagementFlowAsyncResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 1 x-meta: title: Run Management Flow asynchronously | Flow Management description: Run a management flow asynchronously, using a valid management key. keywords: api, flow management /v1/mgmt/flow/list: post: tags: - Mgmt summary: List/Search Flows description: '### List or search flows within a project utilizing a management key. This endpoint is used to list or search flows within a project. To list all flows, send an empty body such as: `{ }` or `{ "ids": [] }`. To search for a flow or several flows, send a body with the flowIds you want to search such as `{ "ids": ["sign-in"] }` or `{ "ids": ["sign-in", "sign-up"] }`. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.' operationId: ListFlows requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchFlowsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListFlowsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 1 x-meta: title: List/Search Flows | Flow Management description: List or search flows within a project utilizing a management key. keywords: api, flow management /v1/mgmt/flow/run: post: tags: - Mgmt summary: Run Management Flow description: Run a management flow, using a valid management key. operationId: RunManagementFlow requestBody: content: application/json: schema: $ref: '#/components/schemas/RunManagementFlowRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunManagementFlowResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 1 x-meta: title: Run Management Flow | Flow Management description: Run a management flow, using a valid management key. keywords: api, flow management /v1/mgmt/flow/externalauth/complete: post: tags: - Mgmt summary: Complete External Authentication description: 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. operationId: CompleteExternalAuthFlow requestBody: content: application/json: schema: $ref: '#/components/schemas/CompleteExternalAuthRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CompleteExternalAuthResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 2 x-meta: title: Complete External Authentication | Flow Management description: 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. keywords: api, flow management /v2/mgmt/flow/export: post: tags: - Mgmt summary: Export Flow description: '### Export an existing flow from a project utilizing a management key. This endpoint is used to export an existing flow from a project. The response is the JSON which includes the flow and associated screens. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.' operationId: ExportFlow requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportFlowRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportFlowResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 2 x-meta: title: Export Flow | Flow Management description: Export an existing flow from a project utilizing a management key. keywords: api, flow management /v2/mgmt/flow/import: post: tags: - Mgmt summary: Import Flow description: '### Import a flow within a project utilizing a management key. This endpoint is used to import a flow to a project. The request items for the `flow` and `screen` this endpoint can be received from the export flow endpoint. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.' operationId: ImportFlow requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportFlowRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 3 x-meta: title: Import Flow | Flow Management description: Import a flow within a project utilizing a management key. keywords: api, flow management /v1/mgmt/flow/delete: post: tags: - Mgmt summary: Delete Flow description: '### Delete a flow within a project utilizing a management key. This endpoint is used to delete a flow from a project by giving an existing flow ID to be deleted. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/manage_flows/) for more information on managing (export, import, delete, disable, enable) flows.' operationId: DeleteFlows requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteFlowsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 4 x-meta: title: Delete Flow | Flow Management description: Delete a flow within a project utilizing a management key. keywords: api, flow management /v2/mgmt/theme/export: post: tags: - Mgmt summary: Export Theme description: '### Export a theme from a project utilizing a management key. This endpoint is used to export a theme from a project. The response is the JSON of the theme. ### See Also - See [Styles Overview](/management/project-settings/styles) for more information on styles and themes' operationId: ExportTheme responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportThemeResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 5 x-meta: title: Export Theme | Flow Management description: Export a theme from a project utilizing a management key. keywords: api, flow management /v2/mgmt/theme/import: post: tags: - Mgmt summary: Import Theme description: '### Import a theme to a project utilizing a management key. This endpoint is used to import a theme from a project. The request body for this endpoint can be received from the export theme endpoint. ### See Also - See [Styles Overview](/management/project-settings/styles) for more information on styles and themes' operationId: ImportTheme requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportThemeRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 6 x-meta: title: Import Theme | Flow Management description: Import a theme to a project utilizing a management key. keywords: api, flow management /v1/mgmt/flow/template/list: post: tags: - Mgmt summary: List Flow Templates description: List all available flow templates operationId: ListFlowTemplates requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchFlowTemplatesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListFlowTemplatesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 7 x-meta: title: List Flow Templates | Flow Management description: List all available flow templates keywords: api, flow management /v1/mgmt/localization/flow/export: post: tags: - Mgmt summary: Export Flow Localization description: Export flow localization, using a valid management key. operationId: ExportFlowLocalization requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportFlowLocalizationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportFlowLocalizationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 8 x-meta: title: Export Flow Localization | Flow Management description: Export flow localization, using a valid management key. keywords: api, flow management /v1/mgmt/localization/flow/import: post: tags: - Mgmt summary: Import Flow Localization description: Import flow localization, using a valid management key. operationId: ImportFlowLocalization requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportFlowLocalizationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImportFlowLocalizationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 9 x-meta: title: Import Flow Localization | Flow Management description: Import flow localization, using a valid management key. keywords: api, flow management /v1/mgmt/widget/list: get: tags: - Mgmt summary: List all widgets description: List all widgets in project operationId: ListWidgets responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWidgetsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: flowManagement x-order: 10 x-meta: title: List all widgets | Flow Management description: List all widgets in project keywords: api, flow management /v1/mgmt/group/all: post: tags: - Mgmt summary: Load All External Groups for a Tenant description: '### Load all external groups for a tenant, using a valid management key. This API endpoint allows administrators to load all external groups that are associated to a tenant. The response contains an array of group objects including the group id, display name, and an array of associated members. ### Next Steps Administrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-group), [Update an Existing SCIM Group (adding new members)](/api/management/tenants/scim/update-scim-group), or [Delete an Existing SCIM Group](/api/management/tenants/scim/delete-scim-group) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: LoadGroups requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadGroupsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadGroupsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: groupManagement x-order: 2 x-meta: title: Load All External Groups for a Tenant | Group Management description: Load all external groups for a tenant, using a valid management key. keywords: api, group management /v1/mgmt/group/member/all: post: tags: - Mgmt summary: Load All External Groups for Specific Members description: '### Load all external group for specific members, using a valid management key. This API endpoint allows administrators to load all external groups for specific members associated with a specific tenant. The tenantId is required and the loginId or userId are optional for further filtering. The response contains an array of group objects including the group id, display name, and an array of associated members. ### Next Steps Administrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-group), [Update an Existing SCIM Group (adding new members)](/api/management/tenants/scim/update-scim-group), or [Delete an Existing SCIM Group](/api/management/tenants/scim/delete-scim-group) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: LoadMemberGroups requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadMemberGroupsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadMemberGroupsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: groupManagement x-order: 2 x-meta: title: Load All External Groups for Specific Members | Group Management description: Load all external group for specific members, using a valid management key. keywords: api, group management /v1/mgmt/group/members: post: tags: - Mgmt summary: Load All Members of a specific External Group description: '### Load all members of a specific External group, using a valid management key. This API endpoint allows administrators to load all members of a specific external group that is associated to a tenant. The response contains an array of group objects including the group id, display name, and an array of associated members. ### Next Steps Administrators can review this information and make changes within their IdP or if necessary, [Create a SCIM Group](/api/management/tenants/scim/create-scim-group), [Update an Existing SCIM Group (adding new members)](/api/management/tenants/scim/update-scim-group), or [Delete an Existing SCIM Group](/api/management/tenants/scim/delete-scim-group) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: LoadGroupMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadGroupMembersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadGroupMembersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: groupManagement x-order: 2 x-meta: title: Load All Members of a specific External Group | Group Management description: Load all members of a specific External group, using a valid management key. keywords: api, group management /v1/mgmt/jwt/templates/create: post: tags: - Mgmt summary: Create JWT Template description: 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. operationId: CreateJwtTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateJwtTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JwtTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Create JWT Template | Jwt Templates description: 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. keywords: api, jwt templates /v1/mgmt/jwt/templates/delete: post: tags: - Mgmt summary: Delete JWT Template description: Delete a JWT template by id. The project's default templates are restored where this one was referenced. operationId: DeleteJwtTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteJwtTemplateRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Delete JWT Template | Jwt Templates description: Delete a JWT template by id. The project's default templates are restored where this one was referenced. keywords: api, jwt templates /v1/mgmt/jwt/templates/library/apply: post: tags: - Mgmt summary: Apply JWT Template From Library description: 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. operationId: ApplyJwtTemplateFromLibrary requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyJwtTemplateFromLibraryRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JwtTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Apply JWT Template From Library | Jwt Templates description: 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. keywords: api, jwt templates /v1/mgmt/jwt/templates/library/list: post: tags: - Mgmt summary: List JWT Template Library description: List the curated JWT template library Descope ships — starter templates with documented use cases, optional logos, and `experimental` flags. operationId: ListJwtTemplateLibrary requestBody: content: application/json: schema: $ref: '#/components/schemas/ListJwtTemplateLibraryRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListJwtTemplateLibraryResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: List JWT Template Library | Jwt Templates description: List the curated JWT template library Descope ships — starter templates with documented use cases, optional logos, and `experimental` flags. keywords: api, jwt templates /v1/mgmt/jwt/templates/library/load: post: tags: - Mgmt summary: Load JWT Template Library Entry description: Load a single library entry by id, including the full claim body — required before applying. operationId: LoadJwtTemplateLibraryEntry requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadJwtTemplateLibraryEntryRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadJwtTemplateLibraryEntryResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Load JWT Template Library Entry | Jwt Templates description: Load a single library entry by id, including the full claim body — required before applying. keywords: api, jwt templates /v1/mgmt/jwt/templates/list: post: tags: - Mgmt summary: List JWT Templates description: 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. operationId: ListJwtTemplates requestBody: content: application/json: schema: $ref: '#/components/schemas/ListJwtTemplatesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListJwtTemplatesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: List JWT Templates | Jwt Templates description: 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. keywords: api, jwt templates /v1/mgmt/jwt/templates/load: post: tags: - Mgmt summary: Load JWT Template description: Load a single JWT template by id. operationId: LoadJwtTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadJwtTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadJwtTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Load JWT Template | Jwt Templates description: Load a single JWT template by id. keywords: api, jwt templates /v1/mgmt/jwt/templates/update: post: tags: - Mgmt summary: Update JWT Template description: Update an existing JWT template by id. Same strict validation as CreateJwtTemplate runs first; on failure the existing template is unchanged. operationId: UpdateJwtTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJwtTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/JwtTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Update JWT Template | Jwt Templates description: Update an existing JWT template by id. Same strict validation as CreateJwtTemplate runs first; on failure the existing template is unchanged. keywords: api, jwt templates /v1/mgmt/jwt/templates/validate: post: tags: - Mgmt summary: Validate JWT Template description: 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. operationId: ValidateJwtTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateJwtTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ValidateJwtTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: jwtTemplates x-meta: title: Validate JWT Template | Jwt Templates description: 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. keywords: api, jwt templates /v1/mgmt/list: post: tags: - Mgmt summary: Create List description: Create a new list operationId: CreateList requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateListResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 1 x-meta: title: Create List | Lists description: Create a new list keywords: api, lists /v1/mgmt/list/update: post: tags: - Mgmt summary: Update List description: Update an existing list operationId: UpdateList requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateListResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 2 x-meta: title: Update List | Lists description: Update an existing list keywords: api, lists /v1/mgmt/list/delete: post: tags: - Mgmt summary: Delete List description: Delete a list by ID operationId: DeleteList requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteListRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 3 x-meta: title: Delete List | Lists description: Delete a list by ID keywords: api, lists /v1/mgmt/list/{id}: get: tags: - Mgmt summary: Get List description: Get a list by ID operationId: GetList parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetListResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 4 x-meta: title: Get List | Lists description: Get a list by ID keywords: api, lists /v1/mgmt/list/name/{name}: get: tags: - Mgmt summary: Get List By Name description: Get a list by name operationId: GetListByName parameters: - name: name in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetListByNameResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 5 x-meta: title: Get List By Name | Lists description: Get a list by name keywords: api, lists /v1/mgmt/list/all: get: tags: - Mgmt summary: Get All Lists description: Get all lists operationId: GetAllLists responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetAllListsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 6 x-meta: title: Get All Lists | Lists description: Get all lists keywords: api, lists /v1/mgmt/list/import: post: tags: - Mgmt summary: Import Lists description: Import multiple lists operationId: ImportLists requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportListsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 7 x-meta: title: Import Lists | Lists description: Import multiple lists keywords: api, lists /v1/mgmt/list/ip/add: post: tags: - Mgmt summary: Add IPs to List description: Add one or more IPs to an existing IP list operationId: AddIPsToList requestBody: content: application/json: schema: $ref: '#/components/schemas/AddIPsToListRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 8 x-meta: title: Add IPs to List | Lists description: Add one or more IPs to an existing IP list keywords: api, lists /v1/mgmt/list/ip/remove: post: tags: - Mgmt summary: Remove IPs from List description: Remove one or more IPs from an existing IP list operationId: RemoveIPsFromList requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveIPsFromListRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 9 x-meta: title: Remove IPs from List | Lists description: Remove one or more IPs from an existing IP list keywords: api, lists /v1/mgmt/list/ip/check: post: tags: - Mgmt summary: Check IP in List description: Check if a specific IP exists in a list operationId: CheckIPInList requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckIPInListRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckIPInListResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 10 x-meta: title: Check IP in List | Lists description: Check if a specific IP exists in a list keywords: api, lists /v1/mgmt/list/clear: post: tags: - Mgmt summary: Clear List description: Clear all IPs from a list operationId: ClearList requestBody: content: application/json: schema: $ref: '#/components/schemas/ClearListRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 11 x-meta: title: Clear List | Lists description: Clear all IPs from a list keywords: api, lists /v1/mgmt/list/text/add: post: tags: - Mgmt summary: Add Texts to List description: Add one or more text items to an existing text list operationId: AddTextsToList requestBody: content: application/json: schema: $ref: '#/components/schemas/AddTextsToListRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 11 x-meta: title: Add Texts to List | Lists description: Add one or more text items to an existing text list keywords: api, lists /v1/mgmt/list/text/remove: post: tags: - Mgmt summary: Remove Texts from List description: Remove one or more text items from an existing text list operationId: RemoveTextsFromList requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveTextsFromListRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 12 x-meta: title: Remove Texts from List | Lists description: Remove one or more text items from an existing text list keywords: api, lists /v1/mgmt/list/text/check: post: tags: - Mgmt summary: Check Text in List description: Check if a specific text exists in a list operationId: CheckTextInList requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckTextInListRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckTextInListResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: lists x-order: 13 x-meta: title: Check Text in List | Lists description: Check if a specific text exists in a list keywords: api, lists /v1/mgmt/project/update/name: post: tags: - Mgmt summary: Rename Project description: '### Rename a project utilizing a management key. This endpoint allows you to update the name of a project. The body only requires the `name` argument. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: UpdateProjectName requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectNameRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 1 x-meta: title: Rename Project | Project Management description: Rename a project utilizing a management key. keywords: api, project management /v1/mgmt/project/export: post: tags: - Mgmt summary: Export Project description: '### Export a project utilizing a management key. This endpoint is used to export a project. The response is the JSON of the project items. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: ExportProject requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportSnapshotRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportSnapshotResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 2 x-meta: title: Export Project | Project Management description: Export a project utilizing a management key. keywords: api, project management /v1/mgmt/project/import: post: tags: - Mgmt summary: Import Project description: "### 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.rotateJwt\n project.cookiepolicy\n project.refreshTokenExpiration\n project.stepupTokenExpiration\n project.sessionTokenExpiration\n project.keySessionTokenExpiration\n project.inviteUrl\n project.inviteEmail\n project.inviteSms\n project.inviteMagicLink\n project.conformanceJwt\n project.inactivity\n\nAuth Methods, Flows, styles, etc:\n magicLink\n enchantedLink\n embeddedLink\n otp\n totp\n sso\n oauth\n webauthn\n password\n styles\n flows\n connectors\n authorization\n attributes\n ssoApps\n```\n\nYou can also import secrets for connectors and OAuth Providers using the `inputSecrets` argument.\n\n### See Also\n- See [Managing Environments](/customize/environments/) for details about managing environments." operationId: ImportProject requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportSnapshotRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 3 x-meta: title: Import Project | Project Management description: Import a project utilizing a management key. keywords: api, project management /v1/mgmt/project/clone: post: tags: - Mgmt summary: Clone Project description: '### Clone a project utilizing a management key. This endpoint allows you to clone the current project, including its settings and configurations. _Note: This requires a pro or enterprise tier licenses. Users, tenants and access keys are not cloned._ ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: CloneProject requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneProjectRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloneProjectResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 4 x-meta: title: Clone Project | Project Management description: Clone a project utilizing a management key. keywords: api, project management /v1/mgmt/project/delete: post: tags: - Mgmt summary: Delete Project description: '### Delete a project utilizing a management key. This endpoint allows you to delete a project. This action is irreversible, use with caution. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: DeleteProject responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 5 x-meta: title: Delete Project | Project Management description: Delete a project utilizing a management key. keywords: api, project management /v1/mgmt/project/clone/async: post: tags: - Mgmt summary: Clone Project (Async) description: 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. operationId: CloneProjectAsync requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneProjectRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CloneProjectAsyncResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 6 x-meta: title: Clone Project (Async) | Project Management description: 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. keywords: api, project management /v1/mgmt/project/clone/async/{processId}: get: tags: - Mgmt summary: Get Clone Project Process description: 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. operationId: GetCloneProjectProcess parameters: - name: processId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetCloneProjectProcessResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 6 x-meta: title: Get Clone Project Process | Project Management description: 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. keywords: api, project management /v1/mgmt/project/snapshot/export: post: tags: - Mgmt summary: Export Project Snapshot description: '### Export a project snapshot utilizing a management key. This endpoint allows you to export a snapshot of the current project state. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: ExportSnapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportSnapshotRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportSnapshotResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 6 x-meta: title: Export Project Snapshot | Project Management description: Export a project snapshot utilizing a management key. keywords: api, project management /v1/mgmt/project/snapshot/import: post: tags: - Mgmt summary: Import Project Snapshot description: '### Import a project snapshot utilizing a management key. This endpoint allows you to import a previously exported project snapshot. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: ImportSnapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportSnapshotRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 7 x-meta: title: Import Project Snapshot | Project Management description: Import a project snapshot utilizing a management key. keywords: api, project management /v1/mgmt/localization/messaging/export: post: tags: - Mgmt summary: Export Messaging Localization description: Export messaging localization, using a valid management key. operationId: ExportMessagingTemplateLocalization requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportMessagingLocalizationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportMessagingLocalizationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 8 x-meta: title: Export Messaging Localization | Project Management description: Export messaging localization, using a valid management key. keywords: api, project management /v1/mgmt/project/snapshot/validate: post: tags: - Mgmt summary: Validate Project Snapshot description: '### Validate a project snapshot utilizing a management key. This endpoint allows you to validate a project snapshot before importing it. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: ValidateSnapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportSnapshotRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ValidateSnapshotResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 8 x-meta: title: Validate Project Snapshot | Project Management description: Validate a project snapshot utilizing a management key. keywords: api, project management /v1/mgmt/localization/messaging/import: post: tags: - Mgmt summary: Import Messaging Localization description: Import messaging localization, using a valid management key. operationId: ImportMessagingLocalization requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportMessagingLocalizationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImportMessagingLocalizationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 9 x-meta: title: Import Messaging Localization | Project Management description: Import messaging localization, using a valid management key. keywords: api, project management /v1/mgmt/project/update/tags: post: tags: - Mgmt summary: Update Project Tags description: '### Update project tags utilizing a management key. This endpoint allows you to update the tags associated with a project. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: UpdateProjectTags requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectTagsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 9 x-meta: title: Update Project Tags | Project Management description: Update project tags utilizing a management key. keywords: api, project management /v1/mgmt/projects/list: post: tags: - Mgmt summary: List Projects description: '### List all projects utilizing a management key. This endpoint allows you to list all projects in your account. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments.' operationId: ListProject requestBody: content: application/json: schema: $ref: '#/components/schemas/ListProjectsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListProjectsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: projectManagement x-order: 10 x-meta: title: List Projects | Project Management description: List all projects utilizing a management key. keywords: api, project management /v1/mgmt/managementkey: get: tags: - Mgmt summary: Get Management Key description: Get a management key using another management key. operationId: GetManagementKey parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetManagementKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: managementKeys x-order: 2 x-meta: title: Get Management Key | Management Keys description: Get a management key using another management key. keywords: api, management keys put: tags: - Mgmt summary: Create Management Key description: Create a management key using another management key. operationId: CreateManagementKey requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateManagementKeyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateManagementKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: managementKeys x-order: 1 x-meta: title: Create Management Key | Management Keys description: Create a management key using another management key. keywords: api, management keys patch: tags: - Mgmt summary: Update Management Key description: Update a management key using another management key. All supported fields will be reset if not provided. operationId: UpdateManagementKey requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagementKeyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateManagementKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: managementKeys x-order: 2 x-meta: title: Update Management Key | Management Keys description: Update a management key using another management key. All supported fields will be reset if not provided. keywords: api, management keys /v1/mgmt/managementkey/search: get: tags: - Mgmt summary: Search Management Keys description: Search management keys using another management key. operationId: SearchManagementKeys responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchManagementKeysResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: managementKeys x-order: 3 x-meta: title: Search Management Keys | Management Keys description: Search management keys using another management key. keywords: api, management keys /v1/mgmt/managementkey/delete: post: tags: - Mgmt summary: Delete Management Key description: Delete a management key using another management key. operationId: DeleteManagementKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteManagementKeysRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteManagementKeysResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: managementKeys x-order: 4 x-meta: title: Delete Management Key | Management Keys description: Delete a management key using another management key. keywords: api, management keys /v1/mgmt/mcp/server/client/create: post: tags: - Mgmt summary: Create MCP Server Client description: Create an MCP Server Client, using a valid management key. operationId: CreateMcpServerClient requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMcpServerClientRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateMcpServerClientResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 1 x-meta: title: Create MCP Server Client | Mcp Server Client Management description: Create an MCP Server Client, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/client/update: post: tags: - Mgmt summary: Update MCP Server Client description: Update an MCP Server Client, using a valid management key. operationId: UpdateMcpServerClient requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMcpServerClientRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateMcpServerClientResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 2 x-meta: title: Update MCP Server Client | Mcp Server Client Management description: Update an MCP Server Client, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/client/load: post: tags: - Mgmt summary: Load MCP Server Client description: Load an MCP Server Client by ID, using a valid management key. operationId: LoadMcpServerClient requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadMcpServerClientRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadMcpServerClientResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 3 x-meta: title: Load MCP Server Client | Mcp Server Client Management description: Load an MCP Server Client by ID, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/client/delete: post: tags: - Mgmt summary: Delete MCP Server Client description: Delete an MCP Server Client by ID, using a valid management key. operationId: DeleteMcpServerClient requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServerClientRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServerClientResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 4 x-meta: title: Delete MCP Server Client | Mcp Server Client Management description: Delete an MCP Server Client by ID, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/clients/delete: post: tags: - Mgmt summary: Delete MCP Server Clients description: Delete multiple MCP Server Clients by IDs, using a valid management key. operationId: DeleteMcpServerClients requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServerClientsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServerClientsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 5 x-meta: title: Delete MCP Server Clients | Mcp Server Client Management description: Delete multiple MCP Server Clients by IDs, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/clients/search: post: tags: - Mgmt summary: Search MCP Server Clients description: Search MCP Server Clients for a specific MCP Server, using a valid management key. operationId: SearchMcpServerClients requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchMcpServerClientsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchMcpServerClientsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 6 x-meta: title: Search MCP Server Clients | Mcp Server Client Management description: Search MCP Server Clients for a specific MCP Server, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/client/secret: post: tags: - Mgmt summary: Get MCP Server Client Secret description: Get MCP Server Client secret, using a valid management key. operationId: GetMcpServerClientSecret requestBody: content: application/json: schema: $ref: '#/components/schemas/GetMcpServerClientSecretRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetMcpServerClientSecretResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 7 x-meta: title: Get MCP Server Client Secret | Mcp Server Client Management description: Get MCP Server Client secret, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/client/secret/rotate: post: tags: - Mgmt summary: Rotate MCP Server Client Secret description: Rotate MCP Server Client secret, using a valid management key. operationId: RotateMcpServerClientSecret requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateMcpServerClientSecretRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RotateMcpServerClientSecretResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerClientManagement x-order: 8 x-meta: title: Rotate MCP Server Client Secret | Mcp Server Client Management description: Rotate MCP Server Client secret, using a valid management key. keywords: api, mcp server client management /v1/mgmt/mcp/server/create: post: tags: - Mgmt summary: Create MCP Server description: Create an MCP Server, using a valid management key. operationId: CreateMcpServer requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMcpServerRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateMcpServerResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerManagement x-order: 1 x-meta: title: Create MCP Server | Mcp Server Management description: Create an MCP Server, using a valid management key. keywords: api, mcp server management /v1/mgmt/mcp/server/update: post: tags: - Mgmt summary: Update MCP Server description: Update an MCP Server, using a valid management key. operationId: UpdateMcpServer requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMcpServerRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateMcpServerResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerManagement x-order: 2 x-meta: title: Update MCP Server | Mcp Server Management description: Update an MCP Server, using a valid management key. keywords: api, mcp server management /v1/mgmt/mcp/server/load: post: tags: - Mgmt summary: Load MCP Server description: Load an MCP Server by ID, using a valid management key. operationId: LoadMcpServer requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadMcpServerRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadMcpServerResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerManagement x-order: 3 x-meta: title: Load MCP Server | Mcp Server Management description: Load an MCP Server by ID, using a valid management key. keywords: api, mcp server management /v1/mgmt/mcp/server/delete: post: tags: - Mgmt summary: Delete MCP Server description: Delete an MCP Server by ID, using a valid management key. operationId: DeleteMcpServer requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServerRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServerResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerManagement x-order: 4 x-meta: title: Delete MCP Server | Mcp Server Management description: Delete an MCP Server by ID, using a valid management key. keywords: api, mcp server management /v1/mgmt/mcp/servers/delete: post: tags: - Mgmt summary: Delete MCP Servers description: Delete multiple MCP Servers by IDs, using a valid management key. operationId: DeleteMcpServers requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteMcpServersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerManagement x-order: 5 x-meta: title: Delete MCP Servers | Mcp Server Management description: Delete multiple MCP Servers by IDs, using a valid management key. keywords: api, mcp server management /v1/mgmt/mcp/servers/all: post: tags: - Mgmt summary: Load All MCP Servers description: Load all MCP Servers for a project, using a valid management key. operationId: LoadAllMcpServers requestBody: content: application/json: schema: $ref: '#/components/schemas/LoadAllMcpServersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllMcpServersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: mcpServerManagement x-order: 6 x-meta: title: Load All MCP Servers | Mcp Server Management description: Load all MCP Servers for a project, using a valid management key. keywords: api, mcp server management /v1/mgmt/outbound/apps: get: tags: - Mgmt summary: List All Outbound Apps description: '### List all outbound applications This endpoint allows you to retrieve all outbound applications configured in your project.' operationId: LoadOutboundApps responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadOutboundAppsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 1 x-meta: title: List All Outbound Apps | Outbound Apps Management description: List all outbound applications keywords: api, outbound apps management /v1/mgmt/outbound/apps-with-user-token: get: tags: - Mgmt summary: List Outbound Apps with User Token description: '### List outbound applications with user token This endpoint allows you to retrieve outbound applications that have a user token available.' operationId: ListUserOutboundAppsWithValidUserToken parameters: - name: userId in: query schema: type: string - name: tenantId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListUserOutboundAppsWithValidUserTokenResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 2 x-meta: title: List Outbound Apps with User Token | Outbound Apps Management description: List outbound applications with user token keywords: api, outbound apps management /v1/mgmt/outbound/app/{id}: get: tags: - Mgmt summary: Get Outbound App by ID description: '### Get outbound application by ID This endpoint allows you to retrieve a specific outbound application by its ID.' operationId: LoadOutboundApp parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadOutboundAppResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 3 x-meta: title: Get Outbound App by ID | Outbound Apps Management description: Get outbound application by ID keywords: api, outbound apps management /v1/mgmt/outbound/app/create: post: tags: - Mgmt summary: Create Outbound App description: '### Create outbound application This endpoint allows you to create a new outbound application.' operationId: CreateOutboundApp requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOutboundAppRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateOutboundAppResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 4 x-meta: title: Create Outbound App | Outbound Apps Management description: Create outbound application keywords: api, outbound apps management /v1/mgmt/outbound/app/update: post: tags: - Mgmt summary: Update Outbound App description: '### Update outbound application This endpoint allows you to update an existing outbound application.' operationId: UpdateOutboundApp requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOutboundAppRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateOutboundAppResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 5 x-meta: title: Update Outbound App | Outbound Apps Management description: Update outbound application keywords: api, outbound apps management /v1/mgmt/outbound/app/delete: post: tags: - Mgmt summary: Delete Outbound App description: '### Delete outbound application This endpoint allows you to delete an outbound application.' operationId: DeleteOutboundApp requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteOutboundAppRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteOutboundAppResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 6 x-meta: title: Delete Outbound App | Outbound Apps Management description: Delete outbound application keywords: api, outbound apps management /v1/mgmt/outbound/app/user/token: post: tags: - Mgmt summary: Fetch Outbound App User Token description: '### Fetch outbound application user token This endpoint allows you to fetch the user token for an outbound application.' operationId: FetchOutboundAppUserToken requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchOutboundAppUserTokenRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FetchOutboundAppUserTokenResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 7 x-meta: title: Fetch Outbound App User Token | Outbound Apps Management description: Fetch outbound application user token keywords: api, outbound apps management /v1/mgmt/outbound/app/user/token/latest: post: tags: - Mgmt summary: Fetch Latest Outbound App User Token description: '### Fetch latest outbound application user token This endpoint allows you to fetch the latest user token for an outbound application.' operationId: FetchLatestOutboundAppUserToken requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchLatestOutboundAppUserTokenRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FetchLatestOutboundAppUserTokenResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 8 x-meta: title: Fetch Latest Outbound App User Token | Outbound Apps Management description: Fetch latest outbound application user token keywords: api, outbound apps management /v1/mgmt/outbound/app/tenant/token: post: tags: - Mgmt summary: Fetch Outbound App Tenant Token description: '### Fetch outbound application tenant token This endpoint allows you to fetch the tenant token for an outbound application.' operationId: FetchOutboundAppTenantToken requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchOutboundAppTenantTokenRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FetchOutboundAppTenantTokenResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 9 x-meta: title: Fetch Outbound App Tenant Token | Outbound Apps Management description: Fetch outbound application tenant token keywords: api, outbound apps management /v1/mgmt/outbound/app/create/bydcrpreset: post: tags: - Mgmt summary: Create outbound application according to existing dcr preset description: Create a new outbound application according to existing dcr preset, using a valid management key. operationId: CreateOutboundAppByDcrPreset requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOutboundAppByDcrPresetRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateOutboundAppByDcrPresetResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 10 x-meta: title: Create outbound application according to existing dcr preset | Outbound Apps Management description: Create a new outbound application according to existing dcr preset, using a valid management key. keywords: api, outbound apps management /v1/mgmt/outbound/app/create/bytemplate: post: tags: - Mgmt summary: Create outbound application by existing template description: Create a new outbound application by existing template using a valid management key. operationId: CreateOutboundAppByTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOutboundAppByTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateOutboundAppByTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 10 x-meta: title: Create outbound application by existing template | Outbound Apps Management description: Create a new outbound application by existing template using a valid management key. keywords: api, outbound apps management /v1/mgmt/outbound/app/tenant/token/latest: post: tags: - Mgmt summary: Fetch Latest Outbound App Tenant Token description: '### Fetch latest outbound application tenant token This endpoint allows you to fetch the latest tenant token for an outbound application.' operationId: FetchLatestOutboundAppTenantToken requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchLatestOutboundAppTenantTokenRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FetchLatestOutboundAppTenantTokenResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 10 x-meta: title: Fetch Latest Outbound App Tenant Token | Outbound Apps Management description: Fetch latest outbound application tenant token keywords: api, outbound apps management /v1/mgmt/outbound/app/connect: post: tags: - Mgmt summary: Connect to outbound application description: Connect to outbound application, using a valid JWT. operationId: ConnectOutboundApp requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectOutboundAppRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ConnectOutboundAppResponse' security: - Descope Project ID:Refresh JWT: [] x-publishYaml: outboundAppsManagement x-order: 11 x-meta: title: Connect to outbound application | Outbound Apps Management description: Connect to outbound application, using a valid JWT. keywords: api, outbound apps management /v1/mgmt/outbound/token: delete: tags: - Mgmt summary: Delete outbound application token by id description: Delete outbound application token by id, using a valid management key. operationId: DeleteOutboundAppTokenByID parameters: - name: id in: query schema: type: string responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 11 x-meta: title: Delete outbound application token by id | Outbound Apps Management description: Delete outbound application token by id, using a valid management key. keywords: api, outbound apps management /v1/mgmt/outbound/user/tokens: delete: tags: - Mgmt summary: Delete outbound application tokens by appId or userId description: Delete outbound application tokens by appId or userId, using a valid management key. operationId: DeleteOutboundAppUserTokens parameters: - name: appId in: query schema: type: string - name: userId in: query schema: type: string responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 12 x-meta: title: Delete outbound application tokens by appId or userId | Outbound Apps Management description: Delete outbound application tokens by appId or userId, using a valid management key. keywords: api, outbound apps management /v1/mgmt/outbound/app/user/apikey/upload: post: tags: - Mgmt summary: Upload user API key for outbound app description: Upload/set a static API key for a user on an apikey-type outbound application, using a valid management key. operationId: UploadOutboundAppUserAPIKey requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadOutboundAppUserAPIKeyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadOutboundAppUserAPIKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 13 x-meta: title: Upload user API key for outbound app | Outbound Apps Management description: Upload/set a static API key for a user on an apikey-type outbound application, using a valid management key. keywords: api, outbound apps management /v1/mgmt/outbound/app/tenant/apikey/upload: post: tags: - Mgmt summary: Upload tenant API key for outbound app description: Upload/set a static API key for a tenant on an apikey-type outbound application, using a valid management key. operationId: UploadOutboundAppTenantAPIKey requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadOutboundAppTenantAPIKeyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadOutboundAppTenantAPIKeyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: outboundAppsManagement x-order: 14 x-meta: title: Upload tenant API key for outbound app | Outbound Apps Management description: Upload/set a static API key for a tenant on an apikey-type outbound application, using a valid management key. keywords: api, outbound apps management /v1/mgmt/password/settings: get: tags: - Mgmt summary: Get Tenant Password Settings description: '### Get password settings for a tenant This endpoint allows you to get the password settings of a given tenant. ### See Also - See [tenant password settings](/customize/tenant#passwords) for details about tenant password settings.' operationId: GetPasswordSettings parameters: - name: tenantId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetPasswordSettingsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: passwordManagement x-order: 1 x-meta: title: Get Tenant Password Settings | Password Management description: Get password settings for a tenant keywords: api, password management post: tags: - Mgmt summary: Update Tenant Password Settings description: '### Update password settings for a tenant This endpoint allows you to update the password settings of a given tenant. ### See Also - See [tenant password settings](/customize/tenant#passwords) for details about tenant password settings.' operationId: ConfigurePasswordSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigurePasswordSettingsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: passwordManagement x-order: 2 x-meta: title: Update Tenant Password Settings | Password Management description: Update password settings for a tenant keywords: api, password management /v1/mgmt/permission/all: get: tags: - Mgmt summary: Load All Permission description: '### Load all permissions, using a valid management key. This API endpoint returns details all permissions configured within the Descope instance. The response includes an array of permissions and these details of each permission: - name - description - systemDefault ### Next Steps Once 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) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: LoadAllPermissions responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadPermissionsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 1 x-meta: title: Load All Permission | Permission Management description: Load all permissions, using a valid management key. keywords: api, permission management /v1/mgmt/permission/create: post: tags: - Mgmt summary: Create Permission description: '### Create a permission, using a valid management key. This API endpoint allows administrators to create a new permission. The endpoint takes the following two parameters: - name (required) - description (optional) ### Next Steps Once you have this data, you can utilize the newly created role to [Create Roles](/api/management/roles/create-role) or [Update Roles](/api/management/roles/update-role) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: CreatePermission requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePermissionRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 2 x-meta: title: Create Permission | Permission Management description: Create a permission, using a valid management key. keywords: api, permission management /v1/mgmt/permission/update: post: tags: - Mgmt summary: Update Permission description: '### Update a permission, using a valid management key. This API endpoint allows administrators to update an existing permission. The endpoint takes the following two parameters: - name (required) - description (optional - though if not provided, it will be removed from the permission) ### Next Steps Once you have this data, you can utilize the newly created role to [Create Roles](/api/management/roles/create-role) or [Update Roles](/api/management/roles/update-role) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: UpdatePermission requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePermissionRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 3 x-meta: title: Update Permission | Permission Management description: Update a permission, using a valid management key. keywords: api, permission management /v1/mgmt/permission/delete: post: tags: - Mgmt summary: Delete Permission description: '### Delete a permission, using a valid management key. This API endpoint allows administrators to delete an existing permission. The endpoint takes the following one parameter: - name (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: DeletePermission requestBody: content: application/json: schema: $ref: '#/components/schemas/DeletePermissionRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 4 x-meta: title: Delete Permission | Permission Management description: Delete a permission, using a valid management key. keywords: api, permission management /v1/mgmt/permission/create/batch: post: tags: - Mgmt summary: Bulk Create Permissions description: Bulk create Permissions, using a valid management key. operationId: CreatePermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePermissionsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 5 x-meta: title: Bulk Create Permissions | Permission Management description: Bulk create Permissions, using a valid management key. keywords: api, permission management /v1/mgmt/permission/update/batch: post: tags: - Mgmt summary: Bulk Update Permissions description: Bulk update Permissions, using a valid management key. operationId: UpdatePermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePermissionsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 6 x-meta: title: Bulk Update Permissions | Permission Management description: Bulk update Permissions, using a valid management key. keywords: api, permission management /v1/mgmt/permission/delete/batch: post: tags: - Mgmt summary: Bulk Delete Permissions description: Bulk delete Permissions, using a valid management key. operationId: DeletePermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/DeletePermissionsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: permissionManagement x-order: 7 x-meta: title: Bulk Delete Permissions | Permission Management description: Bulk delete Permissions, using a valid management key. keywords: api, permission management /v1/mgmt/resource/create: post: tags: - Mgmt summary: Create resource description: Create a new resource, using a valid management key. operationId: CreateResource requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateResourceRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateResourceResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 1 x-meta: title: Create resource | Resources Management description: Create a new resource, using a valid management key. keywords: api, resources management /v1/mgmt/resource/update: post: tags: - Mgmt summary: Update resource description: Update a resource, using a valid management key. operationId: UpdateResource requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResourceRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateResourceResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 2 x-meta: title: Update resource | Resources Management description: Update a resource, using a valid management key. keywords: api, resources management /v1/mgmt/resource/load: get: tags: - Mgmt summary: Load resource by ID description: Load a resource by ID, using a valid management key. operationId: LoadResource parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadResourceResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 3 x-meta: title: Load resource by ID | Resources Management description: Load a resource by ID, using a valid management key. keywords: api, resources management /v1/mgmt/resource/load/uri: get: tags: - Mgmt summary: Load resource by URI description: Load a resource by URI, using a valid management key. operationId: LoadResourceByURI parameters: - name: uri in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadResourceByURIResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 3 x-meta: title: Load resource by URI | Resources Management description: Load a resource by URI, using a valid management key. keywords: api, resources management /v1/mgmt/resource/delete: post: tags: - Mgmt summary: Delete resource description: Delete a resource, using a valid management key. operationId: DeleteResource requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteResourceRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 4 x-meta: title: Delete resource | Resources Management description: Delete a resource, using a valid management key. keywords: api, resources management /v1/mgmt/resource/delete/batch: post: tags: - Mgmt summary: Delete resources batch description: Delete multiple resources, using a valid management key. operationId: DeleteResources requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteResourcesRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 5 x-meta: title: Delete resources batch | Resources Management description: Delete multiple resources, using a valid management key. keywords: api, resources management /v1/mgmt/resources/load: get: tags: - Mgmt summary: Load all resources description: Load all resources, using a valid management key. operationId: LoadAllResources responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllResourcesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcesManagement x-order: 6 x-meta: title: Load all resources | Resources Management description: Load all resources, using a valid management key. keywords: api, resources management /v1/mgmt/resource/dynamic-registration-template/create: post: tags: - Mgmt summary: Create dynamic registration template description: Create a new dynamic registration template, using a valid management key. operationId: CreateDynamicRegistrationTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDynamicRegistrationTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDynamicRegistrationTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: dynamicRegistrationTemplatesManagement x-order: 1 x-meta: title: Create dynamic registration template | Dynamic Registration Templates Management description: Create a new dynamic registration template, using a valid management key. keywords: api, dynamic registration templates management /v1/mgmt/resource/dynamic-registration-template/update: post: tags: - Mgmt summary: Update dynamic registration template description: Update an existing dynamic registration template, using a valid management key. operationId: UpdateDynamicRegistrationTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDynamicRegistrationTemplateRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateDynamicRegistrationTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: dynamicRegistrationTemplatesManagement x-order: 2 x-meta: title: Update dynamic registration template | Dynamic Registration Templates Management description: Update an existing dynamic registration template, using a valid management key. keywords: api, dynamic registration templates management /v1/mgmt/resource/dynamic-registration-template/load: get: tags: - Mgmt summary: Load dynamic registration template description: Load a dynamic registration template by id, using a valid management key. operationId: LoadDynamicRegistrationTemplate parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadDynamicRegistrationTemplateResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: dynamicRegistrationTemplatesManagement x-order: 3 x-meta: title: Load dynamic registration template | Dynamic Registration Templates Management description: Load a dynamic registration template by id, using a valid management key. keywords: api, dynamic registration templates management /v1/mgmt/resource/dynamic-registration-template/delete: post: tags: - Mgmt summary: Delete dynamic registration template description: Delete a dynamic registration template by id, using a valid management key. operationId: DeleteDynamicRegistrationTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteDynamicRegistrationTemplateRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: dynamicRegistrationTemplatesManagement x-order: 4 x-meta: title: Delete dynamic registration template | Dynamic Registration Templates Management description: Delete a dynamic registration template by id, using a valid management key. keywords: api, dynamic registration templates management /v1/mgmt/resource/dynamic-registration-templates/delete: post: tags: - Mgmt summary: Delete dynamic registration templates description: Delete multiple dynamic registration templates by id, using a valid management key. operationId: DeleteDynamicRegistrationTemplates requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteDynamicRegistrationTemplatesRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: dynamicRegistrationTemplatesManagement x-order: 5 x-meta: title: Delete dynamic registration templates | Dynamic Registration Templates Management description: Delete multiple dynamic registration templates by id, using a valid management key. keywords: api, dynamic registration templates management /v1/mgmt/resource/dynamic-registration-templates/load: get: tags: - Mgmt summary: Load all dynamic registration templates description: Load all dynamic registration templates, using a valid management key. operationId: LoadAllDynamicRegistrationTemplates responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllDynamicRegistrationTemplatesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: dynamicRegistrationTemplatesManagement x-order: 6 x-meta: title: Load all dynamic registration templates | Dynamic Registration Templates Management description: Load all dynamic registration templates, using a valid management key. keywords: api, dynamic registration templates management /v1/mgmt/resourcepolicy/create: post: tags: - Mgmt summary: Create resource policy description: Create a new resource policy, using a valid management key. operationId: CreateResourcePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateResourcePolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateResourcePolicyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcePoliciesManagement x-order: 1 x-meta: title: Create resource policy | Resource Policies Management description: Create a new resource policy, using a valid management key. keywords: api, resource policies management /v1/mgmt/resourcepolicy/update: post: tags: - Mgmt summary: Update resource policy description: Update a resource policy, using a valid management key. operationId: UpdateResourcePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResourcePolicyRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateResourcePolicyResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcePoliciesManagement x-order: 2 x-meta: title: Update resource policy | Resource Policies Management description: Update a resource policy, using a valid management key. keywords: api, resource policies management /v1/mgmt/resourcepolicy/delete: post: tags: - Mgmt summary: Delete resource policy description: Delete a resource policy, using a valid management key. operationId: DeleteResourcePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteResourcePolicyRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: resourcePoliciesManagement x-order: 3 x-meta: title: Delete resource policy | Resource Policies Management description: Delete a resource policy, using a valid management key. keywords: api, resource policies management /v1/mgmt/resourcepolicy/app/load: get: tags: - Mgmt summary: Load resource policies by app description: Load resource policies for a specific third party application, using a valid management key. operationId: LoadResourcePoliciesByApp parameters: - name: thirdPartyApplicationId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadResourcePoliciesByAppResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcePoliciesManagement x-order: 4 x-meta: title: Load resource policies by app | Resource Policies Management description: Load resource policies for a specific third party application, using a valid management key. keywords: api, resource policies management /v1/mgmt/resourcepolicy/create/batch: post: tags: - Mgmt summary: Batch create resource policies description: Create multiple resource policies, using a valid management key. operationId: BatchCreateResourcePolicies requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchCreateResourcePoliciesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BatchCreateResourcePoliciesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: resourcePoliciesManagement x-order: 5 x-meta: title: Batch create resource policies | Resource Policies Management description: Create multiple resource policies, using a valid management key. keywords: api, resource policies management /v1/mgmt/resourcepolicy/delete/batch: post: tags: - Mgmt summary: Batch delete resource policies description: Delete multiple resource policies, using a valid management key. operationId: BatchDeleteResourcePolicies requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchDeleteResourcePoliciesRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: resourcePoliciesManagement x-order: 6 x-meta: title: Batch delete resource policies | Resource Policies Management description: Delete multiple resource policies, using a valid management key. keywords: api, resource policies management /v1/mgmt/role/all: get: tags: - Mgmt summary: Load All Roles description: '### Load all roles, using a valid management key. This API endpoint allows administrators to load all existing roles. This endpoint returns an array of roles including their name, description, and permissionsNames. ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: LoadAllRoles responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadRolesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 1 x-meta: title: Load All Roles | Role Management description: Load all roles, using a valid management key. keywords: api, role management /v1/mgmt/role/search: post: tags: - Mgmt summary: Search Roles description: '### Search roles, using a valid management key. This API endpoint allows administrators to search against existing roles. This endpoint returns an array of roles including their name, description, and permissionsNames that match the search parameters. ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: SearchRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadRolesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 2 x-meta: title: Search Roles | Role Management description: Search roles, using a valid management key. keywords: api, role management /v1/mgmt/role/create: post: tags: - Mgmt summary: Create Role description: '### Create a role, using a valid management key. This API endpoint allows administrators to create a new role. The endpoint takes the following three parameters: - name (required) - description (optional) - permissionNames (optional) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: CreateRole requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRoleRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Role' security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 3 x-meta: title: Create Role | Role Management description: Create a role, using a valid management key. keywords: api, role management /v1/mgmt/role/update: post: tags: - Mgmt summary: Update Role description: '### Update an existing role, using a valid management key. This API endpoint allows administrators to update an existing role. The endpoint takes the following four parameters: - name (required) - newName (required) - description (optional - though if not provided, it will be removed from the role)) - permissionNames (optional - though if not provided, it will be removed from the role)) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: UpdateRole requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRoleRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Role' security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 4 x-meta: title: Update Role | Role Management description: Update an existing role, using a valid management key. keywords: api, role management /v1/mgmt/role/delete: post: tags: - Mgmt summary: Delete Role description: '### Delete a role, using a valid management key. This API endpoint allows administrators to delete an existing role. The endpoint takes the following one parameter: - name (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions._override/App.tsx' operationId: DeleteRole requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRoleRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 5 x-meta: title: Delete Role | Role Management description: Delete a role, using a valid management key. keywords: api, role management /v1/mgmt/role/create/batch: post: tags: - Mgmt summary: Bulk Create Roles description: Bulk create Roles, using a valid management key. operationId: CreateRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadRolesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 6 x-meta: title: Bulk Create Roles | Role Management description: Bulk create Roles, using a valid management key. keywords: api, role management /v1/mgmt/role/delete/batch: post: tags: - Mgmt summary: Batch Delete Roles description: '### Delete roles in batch, using a valid management key. This API endpoint allows administrators to delete roles in batch. The endpoint takes the following one parameter: - roleNames (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.' operationId: DeleteRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRolesRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 6 x-meta: title: Batch Delete Roles | Role Management description: Delete roles in batch, using a valid management key. keywords: api, role management /v1/mgmt/role/update/batch: post: tags: - Mgmt summary: Bulk Update Roles description: Bulk update Roles, using a valid management key. operationId: UpdateRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRolesRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadRolesResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: roleManagement x-order: 7 x-meta: title: Bulk Update Roles | Role Management description: Bulk update Roles, using a valid management key. keywords: api, role management /v1/mgmt/sso/idp/app/wsfed/create: post: tags: - Mgmt summary: Create SSO WS-Fed IDP application description: Create a new SSO WS-Fed IDP application, using a valid management key. operationId: CreateSSOWSFedApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateSSOWSFedApplicationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSSOApplicationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 1 x-meta: title: Create SSO WS-Fed IDP application | Sso Apps Management description: Create a new SSO WS-Fed IDP application, using a valid management key. keywords: api, sso apps management /v1/mgmt/sso/idp/apps/load: get: tags: - Mgmt summary: Load All Applications description: '### Load all Applications within a project This endpoint returns details of all Applications within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: LoadAllSSOApplications responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllSSOApplicationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 1 x-meta: title: Load All Applications | Sso Apps Management description: Load all Applications within a project keywords: api, sso apps management /v1/mgmt/sso/idp/app/load: get: tags: - Mgmt summary: Load Application by ID description: '### Load Application by ID within a project This endpoint returns details of a specific Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: LoadSSOApplication parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadSSOApplicationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 2 x-meta: title: Load Application by ID | Sso Apps Management description: Load Application by ID within a project keywords: api, sso apps management /v1/mgmt/sso/idp/app/wsfed/update: post: tags: - Mgmt summary: Update SSO WS-Fed IDP application description: Update a SSO WS-Fed IDP application, using a valid management key. operationId: UpdateSSOWSFedApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateSSOWSFedApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 2 x-meta: title: Update SSO WS-Fed IDP application | Sso Apps Management description: Update a SSO WS-Fed IDP application, using a valid management key. keywords: api, sso apps management /v1/mgmt/sso/idp/app/oidc/create: post: tags: - Mgmt summary: Create OIDC Application description: '### Create OIDC Application within a project This endpoint creates an OIDC Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: CreateSSOOIDCApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateSSOOIDCApplicationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSSOApplicationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 3 x-meta: title: Create OIDC Application | Sso Apps Management description: Create OIDC Application within a project keywords: api, sso apps management /v1/mgmt/sso/idp/app/oidc/update: post: tags: - Mgmt summary: Update OIDC Application description: '### Update OIDC Application within a project This endpoint updates an OIDC Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: UpdateSSOOIDCApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateSSOOIDCApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 4 x-meta: title: Update OIDC Application | Sso Apps Management description: Update OIDC Application within a project keywords: api, sso apps management /v1/mgmt/sso/idp/app/saml/create: post: tags: - Mgmt summary: Create SAML Application description: '### Create SAML Application within a project This endpoint creates a SAML Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: CreateSSOSAMLApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateSSOSAMLApplicationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSSOApplicationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 5 x-meta: title: Create SAML Application | Sso Apps Management description: Create SAML Application within a project keywords: api, sso apps management /v1/mgmt/sso/idp/app/saml/update: post: tags: - Mgmt summary: Update SAML Application description: '### Update SAML Application within a project This endpoint updates a SAML Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: UpdateSSOSAMLApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateSSOSAMLApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 6 x-meta: title: Update SAML Application | Sso Apps Management description: Update SAML Application within a project keywords: api, sso apps management /v1/mgmt/sso/idp/app/delete: post: tags: - Mgmt summary: Delete Application description: '### Delete an Application within a project This endpoint deletes an Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope.' operationId: DeleteSSOApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteSSOApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoAppsManagement x-order: 7 x-meta: title: Delete Application | Sso Apps Management description: Delete an Application within a project keywords: api, sso apps management /v2/mgmt/sso/settings: get: tags: - Mgmt summary: Get Tenant's SAML/OIDC Settings description: '### Get the current SAML/OIDC configuration settings of a tenant, using a valid management key. This API endpoint allows you to get the current SAML/OIDC configuration settings of a tenant. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: LoadSSOSettings parameters: - name: tenantId in: query schema: type: string - name: ssoId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadSSOSettingsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 1 x-meta: title: Get Tenant's SAML/OIDC Settings | Sso Management description: Get the current SAML/OIDC configuration settings of a tenant, using a valid management key. keywords: api, sso management /v2/mgmt/sso/settings/all: get: tags: - Mgmt summary: Load all SSO Settings for a tenant description: Load all SSO Settings for a tenant, using a valid management key. operationId: LoadAllSSOSettings parameters: - name: tenantId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllSSOSettingsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 1 x-meta: title: Load all SSO Settings for a tenant | Sso Management description: Load all SSO Settings for a tenant, using a valid management key. keywords: api, sso management /v1/mgmt/sso/redirect: post: tags: - Mgmt summary: Configure SSO Redirect URL description: Configure tenant SSO Redirect URL, using a valid management key. operationId: ConfigureSSORedirectURL requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureSSORedirectURLRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 2 x-meta: title: Configure SSO Redirect URL | Sso Management description: Configure tenant SSO Redirect URL, using a valid management key. keywords: api, sso management /v1/mgmt/sso/saml: post: tags: - Mgmt summary: Set Tenant's SAML Settings description: '### Configure the SAML Settings, using a valid management key. This API endpoint will configure the SAML settings on a tenant utilizing a valid management key. This API endpoint accepts idpURL, entityId, idpCert, and redirectURL which will be applied to the tenant under SSO Configuration section and will select the option to "Enter the connection details manually" This endpoint also accepts the attribute mapping you would like to be configured on the SAML settings. These configurations will need to be captured directly from your idp provider. The values for each field can be obtained from the admin console of the identity provider. Alternatively, administrators can configure SAML without applying these setting manually via [Configure SAML Metadata URL](/api/management/tenants/sso/configure-sso-saml-settings-by-metadata) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: ConfigureSSOSAMLSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureSSOSAMLSettingsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 2 x-meta: title: Set Tenant's SAML Settings | Sso Management description: Configure the SAML Settings, using a valid management key. keywords: api, sso management /v1/mgmt/sso/saml/metadata: post: tags: - Mgmt summary: Set Tenant's SAML Settings via Metadata URL description: '### Configure the SAML Metadata URL, using a valid management key. This API endpoint will configure the SAML Metadata URL on a tenant utilizing a valid management key. This API endpoint accepts idpMetadataURL which will be applied to the tenant under SSO Configuration section and will select the option to "Retrieve the connection details dynamically using a metadata URL" This endpoint also accepts the attribute mapping you would like to be configured on the SAML settings. This Metadata URL can can be obtained from the admin console of the identity provider. Configuring SAML via Metadata URL allows administrators to configure SAML without applying these setting manually via [Configure SAML Settings](/api/management/tenants/sso/configure-sso-saml-settings) ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: ConfigureSSOSAMLSettingsByMetadata requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureSSOSAMLSettingsByMetadataRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 3 x-meta: title: Set Tenant's SAML Settings via Metadata URL | Sso Management description: Configure the SAML Metadata URL, using a valid management key. keywords: api, sso management /v1/mgmt/sso/oidc: post: tags: - Mgmt summary: Set Tenant's OIDC Settings description: '### Configure the OIDC settings of a tenant, using a valid management key. This API endpoint will configure the OIDC settings on a tenant utilizing a valid management key. This endpoint accepts the OIDC configuration settings as well as the attribute mapping you would like to be configured on the SAML settings. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: ConfigureSSOOIDCSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureSSOOIDCSettingsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 4 x-meta: title: Set Tenant's OIDC Settings | Sso Management description: Configure the OIDC settings of a tenant, using a valid management key. keywords: api, sso management /v1/mgmt/sso/settings/new: post: tags: - Mgmt summary: Create New SSO Settings description: '### Create new SSO settings for a tenant, using a valid management key. This API endpoint allows you to create a new SSO configuration for a tenant. The endpoint accepts the tenant ID, an optional SSO ID, and a display name for the SSO configuration. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: NewSSOSettingsRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/NewSSOSettingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadSSOSettingsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 5 x-meta: title: Create New SSO Settings | Sso Management description: Create new SSO settings for a tenant, using a valid management key. keywords: api, sso management /v1/mgmt/sso/settings: delete: tags: - Mgmt summary: Delete Tenant's SAML/OIDC Settings description: '### Delete the current SAML/OIDC configuration settings of a tenant, using a valid management key. This API endpoint allows you to delete the current SAML/OIDC configuration settings of a tenant. Use this with caution as this endpoint deletes the configuration and is irreversible. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.' operationId: DeleteSSOSettings parameters: - name: tenantId in: query schema: type: string - name: ssoId in: query schema: type: string responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 6 x-meta: title: Delete Tenant's SAML/OIDC Settings | Sso Management description: Delete the current SAML/OIDC configuration settings of a tenant, using a valid management key. keywords: api, sso management /v1/mgmt/sso/recalculate-mappings: post: tags: - Mgmt summary: Recalculate SSO Mappings description: Recalculate SSO group to role mappings for all users in a tenant, using a valid management key. operationId: RecalculateSSOMappings requestBody: content: application/json: schema: $ref: '#/components/schemas/RecalculateSSOMappingsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RecalculateSSOMappingsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: ssoManagement x-order: 10 x-meta: title: Recalculate SSO Mappings | Sso Management description: Recalculate SSO group to role mappings for all users in a tenant, using a valid management key. keywords: api, sso management /v1/mgmt/sso/provider-ids: post: tags: - Mgmt summary: Update SSO Provider IDs description: Update SSO provider IDs and SCIM provider IDs for tenant SSO settings. This endpoint is not publicly documented. operationId: UpdateSSOProviderIDs requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSSOProviderIDsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: internal x-order: 99 x-meta: title: Update SSO Provider IDs | Internal description: Update SSO provider IDs and SCIM provider IDs for tenant SSO settings. This endpoint is not publicly documented. keywords: api, internal /v1/mgmt/tenant/all: get: tags: - Mgmt summary: Load All Tenants description: '### Load all tenants, using a valid management key. This API endpoint returns details of all configured tenants within the Descope instance. The response includes an array of the tenants and these details for each tenant: - id - name - selfProvisioningDomains ### Next Steps - Once you have this data, you can utilize the response to add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: LoadAllTenants responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllTenantsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 1 x-meta: title: Load All Tenants | Tenant Management description: Load all tenants, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant: get: tags: - Mgmt summary: Load Tenant By ID description: '### Load tenant by ID, using a valid management key. This API endpoint returns details of the tenant within the Descope instance that matches the ID provided. The response includes an array of the tenants and these details for each tenant: - id - name - selfProvisioningDomains ### Next Steps - Once you have this data, you can utilize the response to add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: LoadTenant parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadTenantResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 2 x-meta: title: Load Tenant By ID | Tenant Management description: Load tenant by ID, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/search: post: tags: - Mgmt summary: Search Tenants description: '### Search all tenants, using a valid management key. This 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: - id - name - selfProvisioningDomains ### Next Steps - Once you have this data, you can utilize the response to add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: SearchTenants requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchTenantsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllTenantsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 3 x-meta: title: Search Tenants | Tenant Management description: Search all tenants, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/updateDefaultRoles: post: tags: - Mgmt summary: Update Tenant Default Roles description: Update tenant default roles, using a valid management key. operationId: UpdateTenantDefaultRoles requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTenantDefaultRolesRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 3.5 x-meta: title: Update Tenant Default Roles | Tenant Management description: Update tenant default roles, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/create: post: tags: - Mgmt summary: Create Tenant description: '### Create a new tenant, using a valid management key. This API endpoint will create a new tenant utilizing a valid management key. Creation 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. ### Next Steps - You can then add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: CreateTenant requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTenantRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateTenantResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 4 x-meta: title: Create Tenant | Tenant Management description: Create a new tenant, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/update: post: tags: - Mgmt summary: Update Tenant description: '### Update a tenant, using a valid management key. This API endpoint will update a tenant utilizing a valid management key. Utilizing this API endpoint will allow you to update the name or selfProvisioningDomains settings of the tenant. ### Next Steps - You can then add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: UpdateTenant requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTenantRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 5 x-meta: title: Update Tenant | Tenant Management description: Update a tenant, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/delete: post: tags: - Mgmt summary: Delete Tenant description: '### Delete a tenant, using a valid management key. This API endpoint will delete a tenant utilizing a valid management key based on the provided user tenandId. ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: DeleteTenant requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteTenantRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 6 x-meta: title: Delete Tenant | Tenant Management description: Delete a tenant, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/sso-user-remove: post: tags: - Mgmt summary: Remove SSO User from Tenant description: '### Remove an SSO user from a tenant, using a valid management key. This API endpoint removes an SSO user''s association with a tenant. ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.' operationId: RemoveSSOSuffixFromExternalId requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveSSOSuffixFromExternalIdRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: tenantManagement x-order: 7 x-meta: title: Remove SSO User from Tenant | Tenant Management description: Remove an SSO user from a tenant, using a valid management key. keywords: api, tenant management /v1/mgmt/tenant/adminlinks/sso/authenticated: post: tags: - Mgmt summary: Authenticated SSO Admin Link description: '### Authenticated SSO admin link for a tenant, using a valid management key. This API endpoint handles authenticated SSO admin link requests for a tenant.' operationId: GetTenantAdminLinkSSOForAuthenticatedUsers requestBody: content: application/json: schema: $ref: '#/components/schemas/GetTenantAdminLinkSSOForAuthenticateUsersRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GenerateTenantAdminLinkResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantAdminLinkManagement x-order: 4 x-meta: title: Authenticated SSO Admin Link | Tenant Admin Link Management description: Authenticated SSO admin link for a tenant, using a valid management key. keywords: api, tenant admin link management /v2/mgmt/tenant/adminlinks/sso/generate: post: tags: - Mgmt summary: Generate SSO Admin Link description: '### Generate an SSO admin link for a tenant, using a valid management key. This API endpoint generates an SSO admin link that allows a tenant administrator to configure SSO settings.' operationId: GenerateTenantAdminLinkSSO requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateTenantAdminLinkRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GenerateTenantAdminLinkResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantAdminLinkManagement x-order: 1 x-meta: title: Generate SSO Admin Link | Tenant Admin Link Management description: Generate an SSO admin link for a tenant, using a valid management key. keywords: api, tenant admin link management /v1/mgmt/tenant/adminlinks/sso/revoke: post: tags: - Mgmt summary: Revoke SSO Admin Link description: '### Revoke an SSO admin link for a tenant, using a valid management key. This API endpoint revokes an existing SSO admin link for a tenant.' operationId: RevokeTenantAdminLinkSSO requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeTenantAdminLinkRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: tenantAdminLinkManagement x-order: 2 x-meta: title: Revoke SSO Admin Link | Tenant Admin Link Management description: Revoke an SSO admin link for a tenant, using a valid management key. keywords: api, tenant admin link management /v1/mgmt/tenant/adminlinks/sso/send: post: tags: - Mgmt summary: Send SSO Admin Link description: '### Send an SSO admin link to a tenant administrator, using a valid management key. This API endpoint sends an SSO admin link via email to the specified tenant administrator.' operationId: SendTenantAdminLinkSSO requestBody: content: application/json: schema: $ref: '#/components/schemas/SendTenantAdminLinkRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SendTenantAdminLinkResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantAdminLinkManagement x-order: 3 x-meta: title: Send SSO Admin Link | Tenant Admin Link Management description: Send an SSO admin link to a tenant administrator, using a valid management key. keywords: api, tenant admin link management /v1/mgmt/tenant/adminlinks/sso/generate: post: tags: - Mgmt summary: Generate Tenant Admin SSO Link (Deprecated) description: 'Generate tenant admin SSO configuration link, using a valid management key. Deprecated: use the v2 endpoint at /v2/mgmt/tenant/adminlinks/sso/generate instead.' operationId: GenerateTenantAdminLinkSSODeprecated requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateTenantAdminLinkRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GenerateTenantAdminLinkResponse' deprecated: true security: - Descope Project ID and Management Key: [] x-publishYaml: __NO_PUBLISH__ x-order: 8 x-meta: title: Generate Tenant Admin SSO Link (Deprecated) | Tenant Admin Link Management description: 'Generate tenant admin SSO configuration link, using a valid management key. Deprecated: use the v2 endpoint at /v2/mgmt/tenant/adminlinks/sso/generate instead.' keywords: api, tenant admin link management /v1/mgmt/tenant/settings: get: tags: - Mgmt summary: Get Tenant Session Settings description: '### Get session settings for a tenant This endpoint allows you to get the session settings of a given tenant. ### See Also - See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings.' operationId: GetTenantSettings parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetTenantSettingsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: tenantSessionManagement x-order: 7 x-meta: title: Get Tenant Session Settings | Tenant Session Management description: Get session settings for a tenant keywords: api, tenant session management post: tags: - Mgmt summary: Update Tenant Session Settings description: '### Update session settings for a tenant This endpoint allows you to update the session settings of a given tenant. ### See Also - See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings.' operationId: ConfigureTenantSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureTenantSettingsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: tenantSessionManagement x-order: 8 x-meta: title: Update Tenant Session Settings | Tenant Session Management description: Update session settings for a tenant keywords: api, tenant session management /v1/mgmt/tests/generate/otp: post: tags: - Mgmt summary: Generate OTP description: '### Generate an OTP verification code for a test user. This endpoint is used to generate an OTP verification code for a test user. You can define whether this is sent via email or sms. Once you generate the OTP code, you must verify the OTP code via [verify OTP email](/api/otp/email/verify-otp) or [verify OTP sms](/api/otp/sms/verify-otp) ### See Also - See [OTP Authentication](/api/otp/) for details about implementing OTP. - See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test user. - See [Manage Test Users](/manage/testusers/) for more information on test users.' operationId: GenerateOTPForTestUser requestBody: content: application/json: schema: $ref: '#/components/schemas/TestUserGenerateOTPRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestUserGenerateOTPResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: testUserManagement x-order: 1 x-meta: title: Generate OTP | Test User Management description: Generate an OTP verification code for a test user. keywords: api, test user management /v1/mgmt/tests/generate/magiclink: post: tags: - Mgmt summary: Generate Magic Link description: '### Generate a Magic Link for a test user. This endpoint is used to generate a Magic Link for a test user. You can define whether this is sent via email or sms. Once you generate the Magic Link Token must be verified via [verify token](/api/magic-link/verification/verify-token) ### See Also - See [Magic link Authentication](/api/magiclink/) for details about implementing magic links. - See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test user. - See [Manage Test Users](/manage/testusers/) for more information on test users.' operationId: GenerateMagicLinkForTestUser requestBody: content: application/json: schema: $ref: '#/components/schemas/TestUserGenerateMagicLinkRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestUserGenerateMagicLinkResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: testUserManagement x-order: 2 x-meta: title: Generate Magic Link | Test User Management description: Generate a Magic Link for a test user. keywords: api, test user management /v1/mgmt/tests/generate/enchantedlink: post: tags: - Mgmt summary: Generate Enchanted Link description: '### Generate a Enchanted Link for a test user. This endpoint is used to generate a Enchanted Link for a test user. You can define whether this is sent via email or sms. Once you generate the Enchanted Link Token must be verified via [verify token](/api/enchanted-link/verify-token) ### See Also - See [Enchanted link Authentication](/api/enchantedlink/) for details about implementing enchanted links. - See [Create a user](/api/management/users/create-user) with the `test` flag set to true to set it as a test user. - See [Manage Test Users](/manage/testusers/) for more information on test users.' operationId: GenerateEnchantedLinkForTestUser requestBody: content: application/json: schema: $ref: '#/components/schemas/TestUserGenerateEnchantedLinkRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestUserGenerateEnchantedLinkResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: testUserManagement x-order: 3 x-meta: title: Generate Enchanted Link | Test User Management description: Generate a Enchanted Link for a test user. keywords: api, test user management /v1/mgmt/user/test/delete/all: delete: tags: - Mgmt summary: Delete All Test Users description: '### Delete all test users This endpoint is used to delete all test users from a project. This action will delete these users forever and they will not be recoverable. ### See Also - See [Manage Test Users](/manage/testusers/) for more information on test users.' operationId: DeleteAllTestUsers responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteAllTestUsersResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: testUserManagement x-order: 4 x-meta: title: Delete All Test Users | Test User Management description: Delete all test users keywords: api, test user management /v1/mgmt/thirdparty/app/create: post: tags: - Mgmt summary: Create third party application description: Create a new third party application, using a valid management key. operationId: CreateThirdPartyApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateThirdPartyApplicationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateThirdPartyApplicationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 1 x-meta: title: Create third party application | Third Party Apps Management description: Create a new third party application, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/update: post: tags: - Mgmt summary: Update third party application description: Update a third party application, using a valid management key. operationId: UpdateThirdPartyApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateThirdPartyApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 2 x-meta: title: Update third party application | Third Party Apps Management description: Update a third party application, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/patch: post: tags: - Mgmt summary: Patch third party application description: Patch a third party application, using a valid management key. operationId: PatchThirdPartyApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchThirdPartyApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 3 x-meta: title: Patch third party application | Third Party Apps Management description: Patch a third party application, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/load: get: tags: - Mgmt summary: Load third party application by ID description: Loads project third party application by id, using a valid management key. operationId: LoadThirdPartyApplication parameters: - name: id in: query schema: type: string - name: clientId in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadThirdPartyApplicationResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 4 x-meta: title: Load third party application by ID | Third Party Apps Management description: Loads project third party application by id, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/apps/load: get: tags: - Mgmt summary: Load All third party applications description: Loads all project third party applications, using a valid management key. operationId: LoadAllThirdPartyApplications parameters: - name: page in: query schema: type: integer format: int32 - name: limit in: query schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoadAllThirdPartyApplicationsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 5 x-meta: title: Load All third party applications | Third Party Apps Management description: Loads all project third party applications, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/secret: get: tags: - Mgmt summary: Get third party application secret description: Get a third party application secret, using a valid management key. operationId: GetThirdPartyApplicationSecret parameters: - name: id in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetThirdPartyApplicationSecretResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 6 x-meta: title: Get third party application secret | Third Party Apps Management description: Get a third party application secret, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/rotate: post: tags: - Mgmt summary: Rotate third party application secret by application ID description: Rotate the project third party application secret by the application id, using a valid management key. operationId: RotateThirdPartyApplicationSecret requestBody: content: application/json: schema: $ref: '#/components/schemas/RotateThirdPartyApplicationSecretRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RotateThirdPartyApplicationSecretResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 7 x-meta: title: Rotate third party application secret by application ID | Third Party Apps Management description: Rotate the project third party application secret by the application id, using a valid management key. keywords: api, third party apps management get: x-publishYaml: __NO_PUBLISH__ operationId: NoPublishRotate responses: '200': description: Successful operation x-meta: title: undefined | Third Party Apps Management description: No description available keywords: api, third party apps management tags: - Mgmt /v1/mgmt/thirdparty/consents/search: post: tags: - Mgmt summary: Search third party applications consents description: Search third party applications consents, using a valid management key. operationId: SearchThirdPartyApplicationConsents requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchThirdPartyApplicationConsentsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchThirdPartyApplicationConsentsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 8 x-meta: title: Search third party applications consents | Third Party Apps Management description: Search third party applications consents, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/consents/delete: post: tags: - Mgmt summary: Delete third party applications consents description: Delete third party applications consents, using a valid management key. operationId: DeleteThirdPartyApplicationConsents requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteThirdPartyApplicationConsentsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteThirdPartyApplicationConsentsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 9 x-meta: title: Delete third party applications consents | Third Party Apps Management description: Delete third party applications consents, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/consents/delete/tenant: post: tags: - Mgmt summary: Delete third party applications consents by tenant description: Delete third party applications consents by tenant, using a valid management key. operationId: DeleteThirdPartyApplicationTenantConsents requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteThirdPartyApplicationTenantConsentsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteThirdPartyApplicationConsentsResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 10 x-meta: title: Delete third party applications consents by tenant | Third Party Apps Management description: Delete third party applications consents by tenant, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/delete: post: tags: - Mgmt summary: Delete third party application description: Delete a third party application, using a valid management key. operationId: DeleteThirdPartyApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteThirdPartyApplicationRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 11 x-meta: title: Delete third party application | Third Party Apps Management description: Delete a third party application, using a valid management key. keywords: api, third party apps management /v1/mgmt/thirdparty/app/delete/batch: post: tags: - Mgmt summary: Batch delete third party applications description: Delete multiple third party applications in batch, using a valid management key. operationId: DeleteThirdPartyApplications requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteThirdPartyApplicationsRequest' required: true responses: '200': description: OK content: {} security: - Descope Project ID and Management Key: [] x-publishYaml: thirdPartyAppsManagement x-order: 12 x-meta: title: Batch delete third party applications | Third Party Apps Management description: Delete multiple third party applications in batch, using a valid management key. keywords: api, third party apps management /v1/mgmt/user/signup/embeddedlink: post: tags: - Mgmt summary: Generate a token for user sign up, later can be verified with magiclink description: Generate a token for user sign up operationId: EmbeddedLinkSignup requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddedLinkSignUpOrInRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmbeddedLinkSignInResponse' security: - Descope Project ID and Management Key: [] x-publishYaml: embeddedLink x-order: 2 x-meta: title: Generate a token for user sign up, later can be verified with magiclink | Embedded Link description: Generate a token for user sign up keywords: api, embedded link components: schemas: FetchOutboundAppTenantTokenResponse: type: object properties: token: $ref: '#/components/schemas/OutboundAppToken' SAMLIDPRoleGroupMappingInfo: type: object properties: id: type: string name: type: string GetThirdPartyApplicationSecretResponse: type: object properties: cleartext: type: string Analytic: type: object properties: projectId: type: string action: type: string created: type: string device: type: string method: type: string geo: type: string tenant: type: string cnt: type: string referrer: type: string TestUserGenerateMagicLinkResponse: type: object properties: loginId: type: string link: type: string LoadMcpServerClientResponse: type: object properties: client: $ref: '#/components/schemas/McpServerClient' SetUserPasswordRequest: type: object properties: loginId: type: string password: type: string UpdateOutboundAppRequest: type: object properties: app: $ref: '#/components/schemas/OutboundApp' CreateOutboundAppByTemplateResponse: type: object properties: app: $ref: '#/components/schemas/OutboundApp' UsersResponse: type: object properties: users: type: array items: $ref: '#/components/schemas/ResponseUser' total: type: integer format: int32 JWTBearerSettings: type: object properties: issuers: type: object additionalProperties: $ref: '#/components/schemas/IssuerSettings' jwtBearerGrantTypeAudienceToUse: type: string jwtBearerGrantTypeScopeToUse: type: string jwtBearerGrantTypeCustomClaimsToUse: type: string Flow: type: object properties: id: type: string version: type: integer format: int32 name: type: string description: type: string dsl: type: object modifiedTime: type: string etag: type: string disabled: type: boolean translate: type: boolean translateConnectorID: type: string translateSourceLang: type: string translateTargetLangs: type: array items: type: string fingerprint: type: boolean widget: type: boolean sharedInteractions: type: array items: $ref: '#/components/schemas/Interaction' management: type: boolean managementConfig: $ref: '#/components/schemas/ManagementConfig' referencesGlobalStrings: type: boolean ImportFlowLocalizationRequest: type: object properties: flowId: type: string overrides: $ref: '#/components/schemas/FlowLocalizationOverrides' LoadGroupMembersRequest: type: object properties: tenantId: type: string groupId: type: string TargetsRelationsResponse: type: object properties: relations: type: array items: $ref: '#/components/schemas/Relation' CreateUserRequest: type: object properties: loginId: type: string email: type: string phone: type: string verifiedEmail: type: boolean verifiedPhone: type: boolean name: type: string roleNames: type: array items: type: string userTenants: type: array items: $ref: '#/components/schemas/managementv1.AssociatedTenant' invite: type: boolean test: type: boolean default: false customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value picture: type: string sendMail: type: boolean sendSMS: type: boolean additionalIdentifiers: type: array items: type: string inviteUrl: type: string password: type: string hashedPassword: $ref: '#/components/schemas/PasswordImport' givenName: type: string middleName: type: string familyName: type: string ssoAppIds: type: array items: type: string templateOptions: type: object additionalProperties: type: string status: type: string recoveryEmail: type: string recoveryPhone: type: string verifiedRecoveryEmail: type: boolean verifiedRecoveryPhone: type: boolean RemoveIPsFromListRequest: type: object properties: id: type: string ips: type: array items: type: string Group: type: object properties: id: type: string display: type: string members: type: array items: $ref: '#/components/schemas/GroupMember' UpdateDescoperRequest: type: object properties: id: type: string attributes: allOf: - $ref: '#/components/schemas/DescoperAttributes' description: updateable fields (optional! updating attributes has additional constraints) rbac: $ref: '#/components/schemas/DescoperRBAC' GetBackupResponse: type: object properties: backup: $ref: '#/components/schemas/Backup' managementv1.AssociatedTenant: type: object properties: tenantId: type: string roleNames: type: array items: type: string DeleteNamespaceRequest: type: object properties: name: type: string schemaName: type: string description: optional upgrade to the schema name UpdateUserSSOAppsRequest: type: object properties: loginId: type: string ssoAppIds: type: array items: type: string DeleteFlowsRequest: type: object properties: ids: type: array items: type: string LoadOutboundAppsResponse: type: object properties: apps: type: array items: $ref: '#/components/schemas/OutboundApp' AccessKeyResponse: type: object properties: key: $ref: '#/components/schemas/AccessKey' GetMappableSchemaResponse: type: object properties: schema: $ref: '#/components/schemas/Schema' mappableResources: type: array items: $ref: '#/components/schemas/MappableResources' RotateMcpServerClientSecretRequest: type: object properties: id: type: string mcpServerId: type: string CreateDescopersResponse: type: object properties: descopers: type: array items: $ref: '#/components/schemas/Descoper' total: type: integer format: int32 LoadTenantResponse: type: object properties: tenant: $ref: '#/components/schemas/Tenant' ImportListsRequest: type: object properties: lists: type: array items: $ref: '#/components/schemas/List' ThirdPartyApplicationJARSettings: type: object properties: enforce: type: boolean publicKey: type: string maxLifetimeSeconds: type: integer format: int32 fapi: type: boolean description: JAR (JWT-Secured Authorization Request, RFC 9101) settings for Third Party Applications SaveNamespaceResponse: type: object properties: {} UpdateRoleRequest: type: object properties: name: type: string description: Either name or id must be provided (not both). The identified role will be updated. newName: type: string description: type: string permissionNames: type: array items: type: string tenantId: type: string default: type: boolean private: type: boolean id: type: string UpdateUserPhoneRequest: type: object properties: loginId: type: string phone: type: string verified: type: boolean failOnConflict: type: boolean LoadAllSSOSettingsResponse: type: object properties: SSOSettings: type: array items: $ref: '#/components/schemas/LoadSSOSettingsResponse' LoadAllMcpServersRequest: type: object properties: {} ProjectReferences: type: object properties: connectors: type: object additionalProperties: type: string oauth: type: array items: type: string omitted: type: array items: type: string roles: type: object additionalProperties: type: string userAttributes: type: array items: type: string tenantAttributes: type: array items: type: string description: Used by managementservice snapshots - make sure not to break compatibility UpdateDescoperResponse: type: object properties: descoper: $ref: '#/components/schemas/Descoper' SSOApplicationCustomSettings: type: object properties: loginPageUrl: type: string CreateMcpServerClientResponse: type: object properties: id: type: string cleartext: type: string clientId: type: string SearchThirdPartyApplicationConsentsResponse: type: object properties: consents: type: array items: $ref: '#/components/schemas/ThirdPartyApplicationConsent' total: type: integer format: int32 CreateDescopersRequest: type: object properties: descopers: type: array items: $ref: '#/components/schemas/DescoperCreate' RestoreBackupResponse: type: object properties: autoBackupId: type: string ResourceIdentifier: type: object properties: resourceId: type: string resourceType: type: string SearchField: type: object properties: field: type: string valArr: type: array items: type: string valStr: type: string negative: type: boolean valType: type: string description: Custom Attributes CheckPathStep: type: object properties: stepType: type: integer format: enum tuple: $ref: '#/components/schemas/Tuple' permission: type: string subPaths: type: array items: $ref: '#/components/schemas/CheckPath' RelationDefinition: type: object properties: name: type: string description: Name of the relation definition complexDefinition: allOf: - $ref: '#/components/schemas/Node' description: Optional complex definition for complex (union, intersect, sub) relation definitions conditionExpr: type: string description: "DEPRECATED — DO NOT USE. This field MUST NOT be populated by callers and is NEVER\n populated on responses. It is a legacy in-process carrier used only by\n authzservice's DSL save pipeline; SDK implementors (human or AI) MUST NOT read,\n write, or rely on it under any circumstances. Author and read condition\n expressions exclusively through the DSL-based RPCs (SaveDSLSchema / LoadDSLSchema)\n using the `with` clause. This field will be removed in a future release.\n JSON shape, documented only for historical context: {\"name\":\"DuringShift\"} or\n {\"op\":\"and\",\"children\":[...]}." SAMLIDPAttributeMappingInfo: type: object properties: name: type: string type: type: string value: type: string Audit: type: object properties: ID: type: string projectId: type: string userId: type: string action: type: string occurred: type: string device: type: string method: type: string geo: type: string remoteAddress: type: string externalIds: type: array items: type: string tenants: type: array items: type: string data: type: object type: type: string actorId: type: string managementv1.JWTResponse: type: object properties: jwt: type: string MappableResources: type: object properties: type: type: string resources: type: array items: $ref: '#/components/schemas/MappableResource' ThirdPartyApplication: type: object properties: id: type: string name: type: string description: "int64 version - excluded\n int64 createdTime - excluded\n string projectId - copied" description: type: string clientId: type: string logo: type: string loginPageUrl: type: string approvedCallbackUrls: type: array items: type: string permissionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' attributesScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' dynamic: type: boolean status: type: string logoUrl: type: string jwtBearerSettings: allOf: - $ref: '#/components/schemas/JWTBearerSettings' description: 'string backChannelLogoutUrl = 13 [(validate).string = {url: true, optional: true}]; is not supported now as its exist only in project service but there is no end_session endpoint in onetime service' sessionSettings: $ref: '#/components/schemas/managementv1.ThirdPartyApplicationSessionSettings' nonConfidentialClient: type: boolean audienceWhitelist: type: array items: type: string forceAddAllAuthorizationInfo: type: boolean connectionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' defaultAudience: type: string skipConsentScreen: type: boolean useResources: type: boolean customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value cibaSettings: $ref: '#/components/schemas/ThirdPartyApplicationCIBASettings' jarSettings: $ref: '#/components/schemas/ThirdPartyApplicationJARSettings' allowedTenants: type: array items: type: string DeleteDynamicRegistrationTemplatesRequest: type: object properties: ids: type: array items: type: string SnapshotSecret: type: object properties: id: type: string name: type: string type: type: string value: type: string PasswordImportPhpass: type: object properties: hash: type: string salt: type: string iterations: type: integer format: uint32 type: type: string CreateTenantRequest: type: object properties: name: type: string id: type: string selfProvisioningDomains: type: array items: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value authType: type: string disabled: type: boolean enforceSSO: type: boolean enforceSSOExclusions: type: array items: type: string federatedAppIds: type: array items: type: string parent: type: string roleInheritance: type: string LoadJwtTemplateLibraryEntryResponse: type: object properties: entry: $ref: '#/components/schemas/JWTTemplateLibraryEntry' CreateAccessKeyRequest: type: object properties: name: type: string expireTime: type: string roleNames: type: array items: type: string keyTenants: type: array items: $ref: '#/components/schemas/managementv1.AssociatedTenant' userId: type: string customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value description: type: string permittedIps: type: array items: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value CreateUpdateSSOWSFedApplicationRequest: type: object properties: id: type: string name: type: string description: type: string enabled: type: boolean logo: type: string loginPageUrl: type: string realm: type: string replyUrl: type: string attributeMapping: type: array items: $ref: '#/components/schemas/SAMLIDPAttributeMappingInfo' groupsMapping: type: array items: $ref: '#/components/schemas/SAMLIDPGroupsMappingInfo' forceAuthentication: type: boolean logoutRedirectUrl: type: string errorRedirectUrl: type: string CreateBackupRequest: type: object properties: {} JWTTemplate: type: object properties: id: type: string name: type: string description: type: string template: type: object source: type: string tags: type: array items: type: string authSchema: type: string type: type: string conformanceIssuer: type: boolean autoDCT: type: boolean enforceIssuer: type: boolean emptyClaimPolicy: type: string overrideSubject: type: boolean issuerType: type: string omitCustomClaimsFromDSR: type: boolean addJti: type: boolean excludePermissions: type: boolean ManagementConfig: type: object properties: triggers: $ref: '#/components/schemas/ManagementConfigTriggers' CreateMcpServerRequest: type: object properties: name: type: string description: type: string dynamicRegistration: $ref: '#/components/schemas/managementv1.McpServerDynamicClientRegistration' audienceWhitelist: type: array items: type: string approvedScopes: $ref: '#/components/schemas/DynamicClientRegistrationApprovedScopes' approvedCallbackUrls: type: array items: type: string loginPageURL: type: string sessionSettings: $ref: '#/components/schemas/managementv1.ThirdPartyApplicationSessionSettings' tags: type: array items: type: string logo: type: string cimdSettings: $ref: '#/components/schemas/CIMDSettings' skipConsentScreen: type: boolean consentFlowId: type: string consentFlowHostingURL: type: string forceAddAllAuthorizationInfo: type: boolean description: Keep this message synchronized with the matching one in ProjectService Tenant: type: object properties: id: type: string name: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value selfProvisioningDomains: type: array items: type: string authType: type: string domains: type: array items: type: string createdTime: type: integer format: int32 disabled: type: boolean enforceSSO: type: boolean enforceSSOExclusions: type: array items: type: string federatedAppIds: type: array items: type: string parent: type: string successors: type: array items: type: string defaultRoles: type: array items: type: string roleInheritance: type: string UpdateUserTenantRequest: type: object properties: loginId: type: string tenantId: type: string ListJwtTemplatesRequest: type: object properties: {} HasRelationsRequest: type: object properties: relationQueries: type: array items: $ref: '#/components/schemas/RelationQuery' LoadResourceByURIResponse: type: object properties: resource: $ref: '#/components/schemas/Resource' projectv1.ThirdPartyApplicationSessionSettings: type: object properties: enabled: type: boolean refreshTokenExpiration: type: integer format: int32 refreshTokenExpirationUnit: type: string sessionTokenExpiration: type: integer format: int32 sessionTokenExpirationUnit: type: string userTemplateId: type: string keyTemplateId: type: string keySessionTokenExpiration: type: integer format: int32 keySessionTokenExpirationUnit: type: string SearchFlowTemplatesRequest: type: object properties: {} Tuple: type: object properties: resource: type: string description: The resource identifier. example: document-123 resourceType: type: string description: The type of the resource. example: doc relation: type: string description: The relation between the resource and the target. example: editor target: type: string description: The target identifier (user, group, etc.). example: user-456 targetType: type: string description: The type of the target. example: user example: resource: document-123 resourceType: doc relation: editor target: user-456 targetType: user GetPasswordSettingsResponse: type: object properties: minLength: type: integer format: int32 lowercase: type: boolean uppercase: type: boolean number: type: boolean nonAlphanumeric: type: boolean expiration: type: boolean expirationWeeks: type: integer format: int32 reuse: type: boolean reuseAmount: type: integer format: int32 lock: type: boolean lockAttempts: type: integer format: int32 tenantId: type: string enabled: type: boolean tempLock: type: boolean tempLockAttempts: type: integer format: int32 tempLockDuration: type: integer format: int32 enablePasswordStrength: type: boolean passwordStrengthScore: type: integer format: int32 anyLetter: type: boolean disallowedCharacters: type: string disallowEmailMatch: type: boolean DeleteThirdPartyApplicationsRequest: type: object properties: ids: type: array items: type: string CreateOutboundAppByDcrPresetResponse: type: object properties: app: $ref: '#/components/schemas/OutboundApp' CreateManagementKeyRequest: type: object properties: name: type: string description: type: string expiresIn: type: string permittedIps: type: array items: type: string reBac: $ref: '#/components/schemas/ManagementKeyReBac' expireTime: type: string UpdateJwtTemplateRequest: type: object properties: template: $ref: '#/components/schemas/JWTTemplate' ConfigureSSOSAMLSettingsRequest: type: object properties: tenantId: type: string settings: $ref: '#/components/schemas/SSOSAMLSettings' redirectUrl: type: string domains: type: array items: type: string ssoId: type: string LoadMemberGroupsResponse: type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' ExpireUserPasswordRequest: type: object properties: loginId: type: string DeleteSchemaRequest: type: object properties: {} ManagementKeyTagRole: type: object properties: tags: type: array items: type: string roles: type: array items: type: string description: Management key google.protobuf.Value: description: Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. CheckResponseTuple: type: object properties: allowed: type: boolean tuple: $ref: '#/components/schemas/Tuple' info: $ref: '#/components/schemas/CheckResponseInfo' ExportedTheme: type: object properties: styles: type: object componentsVersion: type: string references: $ref: '#/components/schemas/ProjectReferences' description: Used by managementservice snapshots - make sure not to break compatibility FetchOutboundAppUserTokenResponse: type: object properties: token: $ref: '#/components/schemas/OutboundAppToken' UpdateProjectTagsRequest: type: object properties: tags: type: array items: type: string UpdateUserRolesRequest: type: object properties: loginId: type: string tenantId: type: string roleNames: type: array items: type: string UploadOutboundAppTenantAPIKeyRequest: type: object properties: appId: type: string tenantId: type: string apiKey: type: string Descoper: type: object properties: id: type: string attributes: $ref: '#/components/schemas/DescoperAttributes' rbac: $ref: '#/components/schemas/DescoperRBAC' status: type: string loginIDs: type: array items: type: string SendTenantAdminLinkResponse: type: object properties: {} LoadSchemaRequest: type: object properties: {} PasswordImportHash: type: object properties: hash: type: string DeleteOutboundAppRequest: type: object properties: id: type: string SearchAnalyticsResponse: type: object properties: analytics: type: array items: $ref: '#/components/schemas/Analytic' ExportSnapshotResponse: type: object properties: files: type: object UpdateMcpServerRequest: type: object properties: server: $ref: '#/components/schemas/McpServer' SearchManagementKeysResponse: type: object properties: keys: type: array items: $ref: '#/components/schemas/ManagementKey' SearchAuditResponse: type: object properties: audits: type: array items: $ref: '#/components/schemas/Audit' total: type: integer format: int32 BatchCreateResourcePoliciesResponse: type: object properties: resourcePolicies: type: array items: $ref: '#/components/schemas/ResourcePolicy' LoadAllTenantsResponse: type: object properties: tenants: type: array items: $ref: '#/components/schemas/Tenant' LoadRolesResponse: type: object properties: roles: type: array items: $ref: '#/components/schemas/Role' projectv1.McpServerDynamicClientRegistration: type: object properties: enabled: type: boolean disableApprovedScopesAsDefault: type: boolean flowId: type: string LoadResourceResponse: type: object properties: resource: $ref: '#/components/schemas/Resource' DeleteMcpServerClientRequest: type: object properties: id: type: string mcpServerId: type: string GetDescoperResponse: type: object properties: descoper: $ref: '#/components/schemas/Descoper' DeleteRolesRequest: type: object properties: roleNames: type: array items: type: string tenantId: type: string roleIds: type: array items: type: string description: Role IDs — can be combined with roleNames or used alone. FlowLocalizationOverrides: type: object properties: id: type: string version: type: integer format: int32 modifiedTime: type: string flowId: type: string languages: type: object additionalProperties: type: object PasswordImportPbkdf2: type: object properties: hash: type: string format: bytes salt: type: string format: bytes iterations: type: integer format: uint32 type: type: string SSOApplicationOIDCSettings: type: object properties: loginPageUrl: type: string issuer: type: string discoveryUrl: type: string claims: type: array items: type: string forceAuthentication: type: boolean jwtBearerSettings: $ref: '#/components/schemas/JWTBearerSettings' backChannelLogoutUrl: type: string customIdpInitiatedLoginPageUrl: type: string SaveRelationDefinitionRequest: type: object properties: relationDefinition: $ref: '#/components/schemas/RelationDefinition' namespace: type: string oldName: type: string description: Old name if we are renaming the relation definition schemaName: type: string description: optional upgrade to the schema name JWTResponse: type: object properties: sessionJwt: type: string refreshJwt: type: string cookieDomain: type: string cookiePath: type: string cookieMaxAge: type: integer format: int32 cookieExpiration: type: integer format: int32 user: $ref: '#/components/schemas/ResponseUser' firstSeen: type: boolean idpResponse: $ref: '#/components/schemas/IDPResponse' sessionExpiration: type: integer format: int32 externalToken: type: string claims: type: object tenantSSOID: type: string trustedDeviceJwt: type: string nextRefreshSeconds: type: integer format: int32 cookieName: type: string sessionCookieName: type: string sessionCookieDomain: type: string unsavedSSO: type: boolean description: 'NOTE: if you add a new field to this message, also add it to the OptionalJWTResponse message' DynamicRegistrationTemplate: type: object properties: id: type: string version: type: string name: type: string description: type: string loginPageURL: type: string sessionSettings: $ref: '#/components/schemas/projectv1.ThirdPartyApplicationSessionSettings' skipConsentScreen: type: boolean forceAddAllAuthorizationInfo: type: boolean tags: type: array items: type: string createdTime: type: string modifiedTime: type: string description: DynamicRegistrationTemplate CRUD messages UpdatePermissionRequest: type: object properties: name: type: string description: Either name or id must be provided (not both). The identified permission will be updated. newName: type: string description: type: string id: type: string ListFlowTemplatesResponse: type: object properties: templates: type: array items: $ref: '#/components/schemas/FlowTemplate' total: type: integer format: int32 CreateMcpServerClientRequest: type: object properties: name: type: string mcpServerId: type: string approvedCallbackUrls: type: array items: type: string scopes: type: array items: type: string tags: type: array items: type: string logo: type: string forceAddAllAuthorizationInfo: type: boolean allowedTenants: type: array items: type: string DeleteUserRequest: type: object properties: loginId: type: string userId: type: string LoadMcpServerRequest: type: object properties: id: type: string ConditionParam: type: object properties: name: type: string type: type: string ThirdPartyApplicationCIBASettings: type: object properties: enabled: type: boolean expirationTime: type: integer format: int32 expirationTimeUnit: type: string emailServiceProvider: type: string emailServiceProviderFallback: type: string emailServiceTemplateId: type: string loginPageURL: type: string CreateDynamicRegistrationTemplateRequest: type: object properties: name: type: string description: type: string loginPageURL: type: string sessionSettings: $ref: '#/components/schemas/projectv1.ThirdPartyApplicationSessionSettings' skipConsentScreen: type: boolean forceAddAllAuthorizationInfo: type: boolean tags: type: array items: type: string RemoveUserPasskeysRequest: type: object properties: loginId: type: string credentialId: type: string managementv1.ApplicationScope: type: object properties: name: type: string description: type: string optional: type: boolean values: type: array items: type: string description: Keep this message synchronized with the matching one in ProjectService GetManagementFlowAsyncResultRequest: type: object properties: executionId: type: string CreatePermissionRequest: type: object properties: name: type: string description: type: string PasswordImport: type: object properties: bcrypt: $ref: '#/components/schemas/PasswordImportHash' django: $ref: '#/components/schemas/PasswordImportHash' firebase: $ref: '#/components/schemas/PasswordImportFirebase' pbkdf2: $ref: '#/components/schemas/PasswordImportPbkdf2' phpass: $ref: '#/components/schemas/PasswordImportPhpass' md5: $ref: '#/components/schemas/PasswordImportHash' bach: $ref: '#/components/schemas/PasswordImportBach' argon2: $ref: '#/components/schemas/PasswordImportArgon2' sha: $ref: '#/components/schemas/PasswordImportSha' buddyauth: $ref: '#/components/schemas/PasswordImportHash' ValidateSnapshotResponse: type: object properties: ok: type: boolean failures: type: array items: type: string missingSecrets: $ref: '#/components/schemas/SnapshotSecrets' ConfigurePasswordSettingsRequest: type: object properties: minLength: type: integer format: int32 lowercase: type: boolean uppercase: type: boolean number: type: boolean nonAlphanumeric: type: boolean expiration: type: boolean expirationWeeks: type: integer format: int32 reuse: type: boolean reuseAmount: type: integer format: int32 lock: type: boolean lockAttempts: type: integer format: int32 tenantId: type: string enabled: type: boolean tempLock: type: boolean tempLockAttempts: type: integer format: int32 tempLockDuration: type: integer format: int32 enablePasswordStrength: type: boolean passwordStrengthScore: type: integer format: int32 anyLetter: type: boolean disallowedCharacters: type: string disallowEmailMatch: type: boolean ImportAccessKeysRequest: type: object properties: keys: type: array items: $ref: '#/components/schemas/ImportAccessKeyRequest' CheckRequest: type: object properties: tuples: type: array items: $ref: '#/components/schemas/Tuple' computePaths: type: boolean context: type: object description: Optional flat key-value context map for evaluating ABAC conditions GetManagementKeyResponse: type: object properties: key: $ref: '#/components/schemas/ManagementKey' ImportFlowRequest: type: object properties: flow: $ref: '#/components/schemas/ExportedFlow' skipRender: type: boolean changelog: type: string DeleteNamespaceResponse: type: object properties: {} SearchFGAMappableResourcesRequest: type: object properties: tenantId: type: string resourcesQueries: type: array items: $ref: '#/components/schemas/MappableResourceQuery' resourcesLimit: type: string SearchAuditRequest: type: object properties: from: type: string to: type: string userIds: type: array items: type: string actions: type: array items: type: string devices: type: array items: type: string methods: type: array items: type: string geos: type: array items: type: string remoteAddresses: type: array items: type: string externalIds: type: array items: type: string tenants: type: array items: type: string noTenants: type: boolean text: type: string excludedActions: type: array items: type: string actorIds: type: array items: type: string size: type: integer format: int32 page: type: integer format: int32 searchFields: type: array items: $ref: '#/components/schemas/SearchField' oldestFirst: type: boolean loginIdsContain: type: array items: type: string loginIdsNotContain: type: array items: type: string excludedExternalIds: type: array items: type: string auditTypes: type: array items: type: string levels: type: array items: type: string ImportThemeRequest: type: object properties: theme: $ref: '#/components/schemas/ExportedTheme' CreateOutboundAppRequest: type: object properties: id: type: string name: type: string description: type: string clientId: type: string description: 'string templateId = 4 [(validate).string = {std_len: true , optional: true}]; - will always be custom' clientSecret: type: string logo: type: string discoveryUrl: type: string authorizationUrl: type: string authorizationUrlParams: type: array items: $ref: '#/components/schemas/URLParam' tokenUrl: type: string tokenUrlParams: type: array items: $ref: '#/components/schemas/URLParam' revocationUrl: type: string defaultScopes: type: array items: type: string defaultRedirectUrl: type: string callbackDomain: type: string pkce: type: boolean accessType: type: string prompt: type: array items: type: string appType: type: string useDcr: type: boolean dcrUrl: type: string tenantId: type: string GetCloneProjectProcessResponse: type: object properties: projectId: type: string projectName: type: string error: type: string DeleteResourceRelationsForResourcesResponse: type: object properties: {} AddIPsToListRequest: type: object properties: id: type: string ips: type: array items: type: string DeleteRelationsRequest: type: object properties: relations: type: array items: $ref: '#/components/schemas/Relation' RotateThirdPartyApplicationSecretResponse: type: object properties: cleartext: type: string UpdateListRequest: type: object properties: id: type: string name: type: string description: type: string type: type: string data: $ref: '#/components/schemas/google.protobuf.Value' AccessKey: type: object properties: id: type: string name: type: string roleNames: type: array items: type: string keyTenants: type: array items: $ref: '#/components/schemas/AssociatedTenantAK' status: type: string createdTime: type: integer format: int32 expireTime: type: integer format: int32 createdBy: type: string clientId: type: string boundUserId: type: string customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value editable: type: boolean description: type: string permittedIps: type: array items: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value OutboundAppToken: type: object properties: id: type: string appId: type: string userId: type: string tokenSub: type: string accessToken: type: string accessTokenType: type: string accessTokenExpiry: type: string hasRefreshToken: type: boolean refreshToken: type: string lastRefreshTime: type: string lastRefreshError: type: string scopes: type: array items: type: string tenantId: type: string grantedBy: type: string externalIdentifier: type: string Role: type: object properties: name: type: string description: type: string permissionNames: type: array items: type: string createdTime: type: integer format: int32 tenantId: type: string default: type: boolean private: type: boolean id: type: string TestUserGenerateMagicLinkRequest: type: object properties: loginId: type: string deliveryMethod: type: string redirectUrl: type: string loginOptions: $ref: '#/components/schemas/LoginOptions' ExportFlowLocalizationRequest: type: object properties: flowId: type: string ExportFlowLocalizationResponse: type: object properties: overrides: $ref: '#/components/schemas/FlowLocalizationOverrides' GetModifiedResponse: type: object properties: targets: type: array items: type: string resources: type: array items: type: string schemaChanged: type: boolean CreateTuplesResponse: type: object properties: {} WhatCanTargetAccessWithRelationRequest: type: object properties: target: type: string relationDefinition: type: string namespace: type: string ParentTarget: type: string ParentRelationDefinition: type: string DeleteMcpServerRequest: type: object properties: id: type: string UpdateUserImpersonationConsentRequest: type: object properties: loginId: type: string impersonationConsent: type: integer format: int32 DeleteMcpServerClientsResponse: type: object properties: {} SaveSchemaResponse: type: object properties: {} LoginOptions: type: object properties: stepup: type: boolean default: false customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value mfa: type: boolean default: false ssoAppId: type: string templateOptions: type: object additionalProperties: type: string locale: type: string pkceChallenge: type: string description: relevant only for enchanted links in the point in time - other methods will ignore this field format: bytes revokeOtherSessions: type: boolean revokeOtherSessionsTypes: type: array items: type: string tenantId: type: string GroupMember: type: object properties: loginId: type: string userId: type: string display: type: string LoadResourcePoliciesByAppResponse: type: object properties: resourcePolicies: type: array items: $ref: '#/components/schemas/ResourcePolicy' GenerateJWTSignUpRequest: type: object properties: loginId: type: string user: $ref: '#/components/schemas/SignUpUser' emailVerified: type: boolean phoneVerified: type: boolean customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value ssoAppId: type: string refreshDuration: type: integer format: int32 selectedTenantId: type: string userTenants: type: array items: $ref: '#/components/schemas/onetimev1.AssociatedTenant' AnonymousJWTResponse: type: object properties: sessionJwt: type: string refreshJwt: type: string cookieDomain: type: string cookiePath: type: string cookieMaxAge: type: integer format: int32 cookieExpiration: type: integer format: int32 DeleteJwtTemplateRequest: type: object properties: id: type: string FetchOutboundAppUserTokenRequest: type: object properties: appId: type: string userId: type: string scopes: type: array items: type: string options: $ref: '#/components/schemas/FetchOutboundAppTokenOptions' tenantId: type: string externalIdentifier: type: string DeleteAllTuplesResponse: type: object properties: {} UpdateDynamicRegistrationTemplateResponse: type: object properties: template: $ref: '#/components/schemas/DynamicRegistrationTemplate' LoadAllResourcesResponse: type: object properties: resources: type: array items: $ref: '#/components/schemas/Resource' total: type: integer format: int32 UpdateUserRecoveryPhoneRequest: type: object properties: loginId: type: string recoveryPhone: type: string verified: type: boolean SaveDSLSchemaResponse: type: object properties: {} GetListResponse: type: object properties: list: $ref: '#/components/schemas/List' RelationQuery: type: object properties: resource: type: string relationDefinition: type: string namespace: type: string target: type: string hasRelation: type: boolean description: Query if the given resource has the given relation to the given user UploadOutboundAppUserAPIKeyRequest: type: object properties: appId: type: string userId: type: string apiKey: type: string tenantId: type: string CreateTuplesRequest: type: object properties: tuples: type: array items: $ref: '#/components/schemas/Tuple' ListJwtTemplateLibraryResponse: type: object properties: entries: type: array items: $ref: '#/components/schemas/JWTTemplateLibraryEntry' ClearListRequest: type: object properties: id: type: string RotateMcpServerClientSecretResponse: type: object properties: cleartext: type: string CompleteExternalAuthRequest: type: object properties: externalAuthReqId: type: string loginId: type: string user: $ref: '#/components/schemas/SignUpUser' emailVerified: type: boolean phoneVerified: type: boolean customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value selectedTenantId: type: string userTenants: type: array items: $ref: '#/components/schemas/onetimev1.AssociatedTenant' CreateUsersResponse: type: object properties: createdUsers: type: array items: $ref: '#/components/schemas/ResponseUser' failedUsers: type: array items: $ref: '#/components/schemas/CreateUsersFailureResponse' additionalErrors: type: object additionalProperties: type: string LoadPermissionsResponse: type: object properties: permissions: type: array items: $ref: '#/components/schemas/Permission' DescoperCreate: type: object properties: loginId: type: string description: loginId is email-only for descoper creation for now, even if the full loginIds can be other types too. attributes: $ref: '#/components/schemas/DescoperAttributes' sendInvite: type: boolean rbac: $ref: '#/components/schemas/DescoperRBAC' WebauthnImportDevice: type: object properties: descope: $ref: '#/components/schemas/WebauthnImportDescope' auth0: $ref: '#/components/schemas/WebauthnImportAuth0' FetchOutboundAppTenantTokenRequest: type: object properties: appId: type: string tenantId: type: string scopes: type: array items: type: string options: $ref: '#/components/schemas/FetchOutboundAppTokenOptions' externalIdentifier: type: string CreateRelationsRequest: type: object properties: relations: type: array items: $ref: '#/components/schemas/Relation' ExportSnapshotRequest: type: object properties: format: type: string LoadSSOSettingsResponse: type: object properties: tenant: $ref: '#/components/schemas/Tenant' saml: $ref: '#/components/schemas/SamlSettingsResponse' oidc: $ref: '#/components/schemas/SSOOIDCSettings' ssoId: type: string UpdateResourceRequest: type: object properties: resource: $ref: '#/components/schemas/Resource' RunManagementFlowRequest: type: object properties: flowId: type: string options: $ref: '#/components/schemas/ManagementFlowOptions' UserTenants: type: object properties: tenantId: type: string roleNames: type: array items: type: string tenantName: type: string permissions: type: array items: type: string SaveResourcesDetailsResponse: type: object properties: {} description: Response message for saving details for resources Backup: type: object properties: id: type: string projectId: type: string status: type: string schemaVersion: type: integer format: int32 tupleCount: type: integer format: int32 createdAt: type: integer format: int32 completedAt: type: integer format: int32 errorMessage: type: string DeleteManagementKeysResponse: type: object properties: total: type: integer format: int32 UpdateMcpServerClientRequest: type: object properties: id: type: string mcpServerId: type: string name: type: string approvedCallbackUrls: type: array items: type: string scopes: type: array items: type: string tags: type: array items: type: string logo: type: string forceAddAllAuthorizationInfo: type: boolean allowedTenants: type: array items: type: string CreateJwtTemplateRequest: type: object properties: template: $ref: '#/components/schemas/JWTTemplate' WebauthnImportAuth0: type: object properties: keyId: type: string rpId: type: string publicKey: type: string format: bytes aaguid: type: string transports: type: array items: type: string credentialDeviceType: type: string credentialBackedUp: type: boolean userHandle: type: string description: "The keyId, rpId and publicKey fields in this message are present in both passkey and MFA webauthn types.\n The other fields are missing in the MFA webauthn type." SearchMappableResourcesResponse: type: object properties: mappableResources: type: array items: $ref: '#/components/schemas/MappableResources' SaveResourcesDetailsRequest: type: object properties: resourcesDetails: type: array items: $ref: '#/components/schemas/ResourceDetails' description: Request message for saving details for resources managementv1.McpServerDynamicClientRegistration: type: object properties: enabled: type: boolean disableApprovedScopesAsDefault: type: boolean flowId: type: string description: Keep this message synchronized with the matching one in ProjectService ManagementKeyReBac: type: object properties: companyRoles: type: array items: type: string projectRoles: type: array items: $ref: '#/components/schemas/ManagementKeyProjectRole' tagRoles: type: array items: $ref: '#/components/schemas/ManagementKeyTagRole' PasswordImportFirebase: type: object properties: hash: type: string format: bytes salt: type: string format: bytes saltSeparator: type: string format: bytes signerKey: type: string format: bytes memory: type: integer format: uint32 rounds: type: integer format: uint32 RotateThirdPartyApplicationSecretRequest: type: object properties: id: type: string UpdateJWTRequest: type: object properties: jwt: type: string customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value refreshDuration: type: integer format: int32 DeleteRelationsForResourcesResponse: type: object properties: {} DescoperProjectRole: type: object properties: projectIds: type: array items: type: string role: type: string UpdateTenantDefaultRolesRequest: type: object properties: id: type: string defaultRoles: type: array items: type: string GenerateTenantAdminLinkRequest: type: object properties: tenantId: type: string expireTime: type: string email: type: string ssoId: type: string SearchAnalyticsRequest: type: object properties: from: type: string to: type: string actions: type: array items: type: string devices: type: array items: type: string methods: type: array items: type: string geos: type: array items: type: string tenants: type: array items: type: string groupByAction: type: boolean groupByDevice: type: boolean groupByMethod: type: boolean groupByGeo: type: boolean groupByTenant: type: boolean groupByCreated: type: string excludedActions: type: array items: type: string groupByReferrer: type: boolean ImportAccessKeysResponse: type: object properties: keys: type: array items: $ref: '#/components/schemas/AccessKey' PasswordImportBach: type: object properties: hash: type: string key: type: string GenerateJWTSignInRequest: type: object properties: loginId: type: string stepup: type: boolean customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value mfa: type: boolean ssoAppId: type: string revokeOtherSessions: type: boolean jwt: type: string refreshDuration: type: integer format: int32 selectedTenantId: type: string UpdateManagementKeyRequest: type: object properties: id: type: string name: type: string description: type: string permittedIps: type: array items: type: string status: type: string LoadResourcesDetailsRequest: type: object properties: resourceIdentifiers: type: array items: $ref: '#/components/schemas/ResourceIdentifier' description: Request message for loading details for resources DeleteThirdPartyApplicationRequest: type: object properties: id: type: string DeleteThirdPartyApplicationConsentsRequest: type: object properties: consentIds: type: array items: type: string appId: type: string userIds: type: array items: type: string tenantId: type: string RemoveUserPasskeyRequest: type: object properties: loginId: type: string credentialId: type: string UpdateUserDisplayNameRequest: type: object properties: loginId: type: string name: type: string givenName: type: string middleName: type: string familyName: type: string ManagementKeyProjectRole: type: object properties: projectIds: type: array items: type: string roles: type: array items: type: string ListProjectsRequest: type: object properties: {} TestUserGenerateEnchantedLinkResponse: type: object properties: loginId: type: string link: type: string pendingRef: type: string managementv1.ThirdPartyApplicationSessionSettings: type: object properties: enabled: type: boolean refreshTokenExpiration: type: integer format: int32 refreshTokenExpirationUnit: type: string sessionTokenExpiration: type: integer format: int32 sessionTokenExpirationUnit: type: string userTemplateId: type: string keyTemplateId: type: string keySessionTokenExpiration: type: integer format: int32 keySessionTokenExpirationUnit: type: string UserAuthHistory: type: object properties: userId: type: string loginTime: type: integer format: int32 city: type: string country: type: string ip: type: string selectedTenant: type: string UserProviderTokenResponse: type: object properties: provider: type: string providerUserId: type: string accessToken: type: string expiration: type: integer format: uint32 scopes: type: array items: type: string refreshToken: type: string SaveSchemaDryDeletes: type: object properties: hasDeletes: type: boolean relations: type: array items: type: string types: type: array items: type: string WhatCanTargetAccessRequest: type: object properties: target: type: string SSOSetupSuiteSettings: type: object properties: enabled: type: boolean styleId: type: string disabledFeatures: $ref: '#/components/schemas/SSOSetupSuiteSettingsDisabledFeatures' DeleteRoleRequest: type: object properties: name: type: string description: Either name or id must be provided (not both). tenantId: type: string id: type: string UpdateMcpServerClientResponse: type: object properties: client: $ref: '#/components/schemas/McpServerClient' ResourceRelationsRequest: type: object properties: resource: type: string ignoreTargetSetRelations: type: boolean TestUserGenerateOTPRequest: type: object properties: loginId: type: string deliveryMethod: type: string loginOptions: $ref: '#/components/schemas/LoginOptions' ExportFlowRequest: type: object properties: flowId: type: string CIMDSettings: type: object properties: enabled: type: boolean domainPolicies: $ref: '#/components/schemas/CIMDDomainPolicies' ManagementConfigTriggers: type: object properties: enabled: type: boolean triggerType: type: string eventTriggers: $ref: '#/components/schemas/ManagementConfigEventTriggers' CreatePermissionsRequest: type: object properties: permissions: type: array items: $ref: '#/components/schemas/CreatePermissionRequest' PatchUserBatchResponse: type: object properties: patchedUsers: type: array items: $ref: '#/components/schemas/ResponseUser' failedUsers: type: array items: $ref: '#/components/schemas/PatchUserBatchFailureResponse' additionalErrors: type: object additionalProperties: type: string ListWidgetsResponse: type: object properties: widgets: type: array items: $ref: '#/components/schemas/Widget' CreateAuditRequest: type: object properties: userId: type: string action: type: string tenantId: type: string type: type: string actorId: type: string data: type: object CheckResponse: type: object properties: tuples: type: array items: $ref: '#/components/schemas/CheckResponseTuple' GetMcpServerClientSecretResponse: type: object properties: cleartext: type: string ApplyJwtTemplateFromLibraryRequest: type: object properties: libraryEntryId: type: string nameOverride: type: string description: Optional overrides applied on top of the library entry before save. descriptionOverride: type: string tagsOverride: type: array items: type: string templateOverride: type: object UpdatePermissionsRequest: type: object properties: permissions: type: array items: $ref: '#/components/schemas/UpdatePermissionRequest' UpdateSSOProviderIDsRequest: type: object properties: tenantId: type: string ssoId: type: string samlProviderId: type: string samlScimProviderId: type: string oidcProviderId: type: string oidcScimProviderId: type: string List: type: object properties: id: type: string name: type: string description: type: string type: type: string data: $ref: '#/components/schemas/google.protobuf.Value' description: Lists FetchLatestOutboundAppTenantTokenRequest: type: object properties: appId: type: string tenantId: type: string options: $ref: '#/components/schemas/FetchOutboundAppTokenOptions' externalIdentifier: type: string Relation: type: object properties: resource: type: string description: Relation is defined on the resource relationDefinition: type: string description: The name of the relation definition namespace: type: string description: The namespace of the relation definition target: type: string description: The target for given the relation targetNamespace: type: string description: The target namespace for the relation targetSetResource: type: string description: The targetSet target resource for the relation targetSetRelationDefinition: type: string description: The targetSet target relation definition for the relation targetSetRelationDefinitionNamespace: type: string description: The targetSet target relation definition namespace for the relation query: allOf: - $ref: '#/components/schemas/UserQuery' description: User query for a list of users target description: Relation is specified between resource and target where target can be direct target (user or related resource), targetSet (anyone who has another relation), and list of users matching query SAMLIDPGroupsMappingInfo: type: object properties: name: type: string type: type: string filterType: type: string value: type: string roles: type: array items: $ref: '#/components/schemas/SAMLIDPRoleGroupMappingInfo' CreateListResponse: type: object properties: list: $ref: '#/components/schemas/List' CreateAccessKeyResponse: type: object properties: cleartext: type: string key: $ref: '#/components/schemas/AccessKey' WhoCanAccessRequest: type: object properties: resource: type: string relationDefinition: type: string namespace: type: string description: Query the list of users who have the relation to the resource LoadSSOApplicationResponse: type: object properties: app: $ref: '#/components/schemas/SSOApplication' UpdateResourceResponse: type: object properties: resource: $ref: '#/components/schemas/Resource' UpdateUserPictureRequest: type: object properties: loginId: type: string picture: type: string PasswordImportArgon2: type: object properties: hash: type: string format: bytes salt: type: string format: bytes iterations: type: integer format: uint32 memory: type: integer format: uint32 threads: type: integer format: uint32 type: type: string RevokeTenantAdminLinkRequest: type: object properties: tenantId: type: string ssoId: type: string DeleteRelationDefinitionRequest: type: object properties: name: type: string namespace: type: string schemaName: type: string description: optional upgrade to the schema name Interaction: type: object properties: id: type: string type: type: string label: type: string icon: type: string subType: type: string ImportMessagingLocalizationResponse: type: object properties: overrides: $ref: '#/components/schemas/TemplateLocalizationOverrides' LoadJwtTemplateLibraryEntryRequest: type: object properties: id: type: string LoadGroupsRequest: type: object properties: tenantId: type: string SortField: type: object properties: field: type: string description: 'Field must be from the give list: id, modifiedTime, createdTime, externalId, displayName, tenant, phoneNumber, email, status' desc: type: boolean WhoCanAccessResponse: type: object properties: targets: type: array items: type: string ExportedFlowMetadata: type: object properties: name: type: string description: type: string componentsVersion: type: string disabled: type: boolean fingerprint: type: boolean widget: type: boolean translation: $ref: '#/components/schemas/ExportedFlowTranslation' sharedInteractions: type: array items: $ref: '#/components/schemas/Interaction' management: type: boolean managementConfig: $ref: '#/components/schemas/ManagementConfig' description: Used by managementservice snapshots - make sure not to break compatibility FetchLatestOutboundAppTenantTokenResponse: type: object properties: token: $ref: '#/components/schemas/OutboundAppToken' LoadResourcesDetailsResponse: type: object properties: resourcesDetails: type: array items: $ref: '#/components/schemas/ResourceDetails' description: Response message for loading details for resources SaveSchemaDryRunResponse: type: object properties: deletesPreview: $ref: '#/components/schemas/SaveSchemaDryDeletes' AttributeMapping: type: object properties: name: type: string email: type: string group: type: string givenName: type: string middleName: type: string familyName: type: string picture: type: string customAttributes: type: object additionalProperties: type: string CreateManagementKeyResponse: type: object properties: cleartext: type: string key: $ref: '#/components/schemas/ManagementKey' GetListByNameResponse: type: object properties: list: $ref: '#/components/schemas/List' DeleteResourcesRequest: type: object properties: ids: type: array items: type: string ConfigureSSOSAMLSettingsByMetadataRequest: type: object properties: tenantId: type: string settings: $ref: '#/components/schemas/SSOSAMLByMetadataSettings' redirectUrl: type: string domains: type: array items: type: string ssoId: type: string McpServer: type: object properties: id: type: string name: type: string description: type: string dynamicRegistration: $ref: '#/components/schemas/managementv1.McpServerDynamicClientRegistration' audienceWhitelist: type: array items: type: string approvedScopes: $ref: '#/components/schemas/DynamicClientRegistrationApprovedScopes' approvedCallbackUrls: type: array items: type: string loginPageURL: type: string sessionSettings: $ref: '#/components/schemas/managementv1.ThirdPartyApplicationSessionSettings' tags: type: array items: type: string logo: type: string cimdSettings: $ref: '#/components/schemas/CIMDSettings' skipConsentScreen: type: boolean forceAddAllAuthorizationInfo: type: boolean description: Keep this message synchronized with the matching one in ProjectService CreateBackupResponse: type: object properties: backupId: type: string RoleMapping: type: object properties: groups: type: array items: type: string roleName: type: string PatchUserRequest: type: object properties: loginId: type: string email: type: string phone: type: string verifiedEmail: type: boolean verifiedPhone: type: boolean name: type: string roleNames: $ref: '#/components/schemas/google.protobuf.Value' userTenants: $ref: '#/components/schemas/google.protobuf.Value' status: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value picture: type: string givenName: type: string middleName: type: string familyName: type: string ssoAppIds: $ref: '#/components/schemas/google.protobuf.Value' additionalIdentifiers: type: array items: type: string recoveryEmail: type: string recoveryPhone: type: string verifiedRecoveryEmail: type: boolean verifiedRecoveryPhone: type: boolean UpdateAccessKeyRequest: type: object properties: id: type: string name: type: string description: type: string roleNames: allOf: - $ref: '#/components/schemas/google.protobuf.Value' description: we want to differentiate between empty and nil so we use google.protobuf.Value keyTenants: $ref: '#/components/schemas/google.protobuf.Value' customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value permittedIps: $ref: '#/components/schemas/google.protobuf.Value' customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value ExportMessagingLocalizationResponse: type: object properties: overrides: $ref: '#/components/schemas/TemplateLocalizationOverrides' RecalculateSSOMappingsRequest: type: object properties: tenantId: type: string ssoId: type: string ManagementConfigEventTriggers: type: object properties: triggeringEventTypes: type: array items: type: string ImportUserPasskeysRequest: type: object properties: loginId: type: string devices: type: array items: $ref: '#/components/schemas/WebauthnImportDevice' DeleteBackupResponse: type: object properties: {} FetchLatestOutboundAppUserTokenResponse: type: object properties: token: $ref: '#/components/schemas/OutboundAppToken' GetModifiedRequest: type: object properties: since: type: string description: Changed since given milli epoch UTC time - optional, default to max changelog (change events) TTL LoadJwtTemplateResponse: type: object properties: template: $ref: '#/components/schemas/JWTTemplate' RunManagementFlowResponse: type: object properties: output: type: object ListUserPasskeysRequest: type: object properties: loginId: type: string FlowTemplateScreen: type: object properties: id: type: string inputs: type: array items: $ref: '#/components/schemas/Input' interactions: type: array items: $ref: '#/components/schemas/Interaction' htmlTemplate: type: object CreateMcpServerResponse: type: object properties: server: $ref: '#/components/schemas/McpServer' LoadMcpServerClientRequest: type: object properties: id: type: string clientId: type: string mcpServerId: type: string DescoperAttributes: type: object properties: displayName: type: string email: type: string phone: type: string description: Descopers CreateResourceResponse: type: object properties: resource: $ref: '#/components/schemas/Resource' DeleteSchemaResponse: type: object properties: {} DeleteSSOApplicationRequest: type: object properties: id: type: string StringArray: type: object properties: values: type: array items: type: string and: type: boolean DeleteUsersRequest: type: object properties: userIds: type: array items: type: string SaveDSLSchemaRequest: type: object properties: dsl: type: string description: New API RecalculateSSOMappingsResponse: type: object properties: {} LoadGroupMembersResponse: type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' CheckIPInListRequest: type: object properties: id: type: string ip: type: string ListDescopersRequest: type: object properties: {} UserQuery: type: object properties: tenants: type: array items: type: string description: If not empty then users must be members of at least one of these tenants roles: type: array items: type: string description: If not empty then users must have one of the specified roles text: type: string description: Full text search across relevant columns (displayName, email, tenants, status) statuses: type: array items: type: string description: If not empty then users must be in one of the given statuses ssoOnly: type: boolean description: Return only users that have SSO external IDs default: false withTestUser: type: boolean description: Return also users which are test users customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value onetimev1.AssociatedTenant: type: object properties: tenantId: type: string roleNames: type: array items: type: string ImportAccessKeyRequest: type: object properties: name: type: string expireTime: type: string roleNames: type: array items: type: string keyTenants: type: array items: $ref: '#/components/schemas/managementv1.AssociatedTenant' userId: type: string customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value description: type: string permittedIps: type: array items: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value cleartext: type: string RemoveUserTOTPRequest: type: object properties: loginId: type: string DeleteThirdPartyApplicationConsentsResponse: type: object properties: {} PatchUserBatchFailureResponse: type: object properties: failure: type: string user: $ref: '#/components/schemas/ResponseUser' URLParam: type: object properties: key: type: string value: type: string PatchUserBatchRequest: type: object properties: users: type: array items: $ref: '#/components/schemas/PatchUserRequest' LoadMcpServerResponse: type: object properties: server: $ref: '#/components/schemas/McpServer' SSOApplicationWSFedSettings: type: object properties: loginPageUrl: type: string realm: type: string replyUrl: type: string attributeMapping: type: array items: $ref: '#/components/schemas/SAMLIDPAttributeMappingInfo' groupsMapping: type: array items: $ref: '#/components/schemas/SAMLIDPGroupsMappingInfo' forceAuthentication: type: boolean logoutRedirectUrl: type: string errorRedirectUrl: type: string idpCert: type: string idpInitiatedUrl: type: string idpMetadataUrl: type: string idpEntityId: type: string idpSsoUrl: type: string idpLogoutUrl: type: string UserLogoutRequest: type: object properties: loginId: type: string userId: type: string sessionTypes: type: array items: type: string ConfigureSSOOIDCSettingsRequest: type: object properties: tenantId: type: string settings: $ref: '#/components/schemas/SSOOIDCSettings' domains: type: array items: type: string ssoId: type: string TemplateLocalizationOverrides: type: object properties: id: type: string version: type: integer format: int32 modifiedTime: type: string languages: type: object additionalProperties: type: object DeleteMcpServersRequest: type: object properties: ids: type: array items: type: string DeleteTuplesResponse: type: object properties: {} PasswordImportSha: type: object properties: hash: type: string type: type: string salt: type: string ListJwtTemplateLibraryRequest: type: object properties: {} UploadOutboundAppTenantAPIKeyResponse: type: object properties: {} AnonymousUserRequest: type: object properties: customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value selectedTenant: type: string refreshDuration: type: integer format: int32 roles: type: array items: type: string SSOApplication: type: object properties: id: type: string name: type: string description: "int64 version - excluded\n int64 createdTime - excluded\n string projectId - copied" description: type: string enabled: type: boolean logo: type: string appType: type: string samlSettings: $ref: '#/components/schemas/SSOApplicationSAMLSettings' oidcSettings: $ref: '#/components/schemas/SSOApplicationOIDCSettings' customSettings: $ref: '#/components/schemas/SSOApplicationCustomSettings' wsfedSettings: $ref: '#/components/schemas/SSOApplicationWSFedSettings' DeleteListRequest: type: object properties: id: type: string UpdateUserStatusRequest: type: object properties: loginId: type: string status: type: string CheckPath: type: object properties: steps: type: array items: $ref: '#/components/schemas/CheckPathStep' DeleteMcpServerResponse: type: object properties: {} CreateUpdateSSOOIDCApplicationRequest: type: object properties: id: type: string name: type: string description: type: string enabled: type: boolean logo: type: string loginPageUrl: type: string claims: type: array items: type: string forceAuthentication: type: boolean backChannelLogoutUrl: type: string jwtBearerSettings: $ref: '#/components/schemas/JWTBearerSettings' customIdpInitiatedLoginPageUrl: type: string AddTextsToListRequest: type: object properties: id: type: string texts: type: array items: type: string GetAllListsResponse: type: object properties: lists: type: array items: $ref: '#/components/schemas/List' ReBACGroupsMappingRelation: type: object properties: resource: type: string description: Resource identifier of the relation relationDefinition: type: string description: The name of the relation definition namespace: type: string description: The namespace of the relation definition CloneProjectResponse: type: object properties: projectId: type: string projectName: type: string tag: type: string environment: type: string tags: type: array items: type: string ListBackupsResponse: type: object properties: backups: type: array items: $ref: '#/components/schemas/Backup' ImpersonateRequest: type: object properties: loginId: type: string impersonatorId: type: string validateConsent: type: boolean customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value selectedTenant: type: string refreshDuration: type: integer format: int32 sessionCookieName: type: string RemoveTextsFromListRequest: type: object properties: id: type: string texts: type: array items: type: string DeleteMcpServerClientResponse: type: object properties: {} ListTrustedDevicesForUsersResponse: type: object properties: devices: type: array items: $ref: '#/components/schemas/TrustedDevice' ListDescopersResponse: type: object properties: descopers: type: array items: $ref: '#/components/schemas/Descoper' total: type: integer format: int32 SSOApplicationSAMLSettings: type: object properties: loginPageUrl: type: string idpCert: type: string useMetadataInfo: type: boolean metadataUrl: type: string entityId: type: string acsUrl: type: string certificate: type: string attributeMapping: type: array items: $ref: '#/components/schemas/SAMLIDPAttributeMappingInfo' groupsMapping: type: array items: $ref: '#/components/schemas/SAMLIDPGroupsMappingInfo' idpMetadataUrl: type: string idpEntityId: type: string idpSsoUrl: type: string acsAllowedCallbacks: type: array items: type: string subjectNameIdType: type: string subjectNameIdFormat: type: string defaultRelayState: type: string idpInitiatedUrl: type: string forceAuthentication: type: boolean idpLogoutUrl: type: string logoutRedirectUrl: type: string errorRedirectUrl: type: string defaultSignatureAlgorithm: type: string ExportThemeResponse: type: object properties: theme: $ref: '#/components/schemas/ExportedTheme' DeleteRelationsResponse: type: object properties: {} CreateThirdPartyApplicationResponse: type: object properties: id: type: string cleartext: type: string clientId: type: string Permission: type: object properties: name: type: string description: type: string systemDefault: type: boolean id: type: string SearchMcpServerClientsResponse: type: object properties: clients: type: array items: $ref: '#/components/schemas/McpServerClient' total: type: integer format: int32 LoadDynamicRegistrationTemplateResponse: type: object properties: template: $ref: '#/components/schemas/DynamicRegistrationTemplate' DynamicRegistrationSettings: type: object properties: dynamicRegistration: $ref: '#/components/schemas/projectv1.McpServerDynamicClientRegistration' cimdSettings: $ref: '#/components/schemas/CIMDSettings' dynamicRegistrationTemplateId: type: string useTemplate: type: boolean loginPageURL: type: string skipConsentScreen: type: boolean forceAddAllAuthorizationInfo: type: boolean tags: type: array items: type: string sessionSettings: $ref: '#/components/schemas/projectv1.ThirdPartyApplicationSessionSettings' description: "DynamicRegistrationSettings groups the DCR/CIMD configuration plus inline\n client-side defaults for an mcp-typed Resource. Only meaningful when the\n parent Resource has type=mcp.\n\n When useTemplate is true, the resource MUST reference a non-empty\n dynamicRegistrationTemplateId, and the client defaults\n (loginPageURL, sessionSettings, skipConsentScreen,\n forceAddAllAuthorizationInfo, tags, plus template-only approvedCallbackUrls\n and logo) are sourced from that template. When useTemplate is false, the\n inline fields on this message are used directly." UpdateUserEmailRequest: type: object properties: loginId: type: string email: type: string verified: type: boolean failOnConflict: type: boolean PatchThirdPartyApplicationRequest: type: object properties: id: type: string name: type: string description: type: string logo: type: string loginPageUrl: type: string approvedCallbackUrls: type: array items: type: string permissionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' attributesScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' logoUrl: type: string jwtBearerSettings: allOf: - $ref: '#/components/schemas/JWTBearerSettings' description: 'string backChannelLogoutUrl = 10 [(validate).string = {url: true, optional: true}];' sessionSettings: $ref: '#/components/schemas/managementv1.ThirdPartyApplicationSessionSettings' audienceWhitelist: type: array items: type: string forceAddAllAuthorizationInfo: type: boolean connectionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' defaultAudience: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value cibaSettings: $ref: '#/components/schemas/ThirdPartyApplicationCIBASettings' jarSettings: $ref: '#/components/schemas/ThirdPartyApplicationJARSettings' allowedTenants: type: array items: type: string ListUserPasskeysResponse: type: object properties: passkeys: type: array items: $ref: '#/components/schemas/UserPasskey' LoadOutboundAppResponse: type: object properties: app: $ref: '#/components/schemas/OutboundApp' WebauthnImportDescope: type: object properties: credentialId: type: string rpId: type: string publicKey: type: string format: bytes attestationType: type: string default: false aaguid: type: string transports: type: array items: type: string backupEligible: type: boolean backupState: type: boolean FetchOutboundAppTokenOptions: type: object properties: withRefreshToken: type: boolean forceRefresh: type: boolean ExportedScreen: type: object properties: screenId: type: string interactions: type: array items: $ref: '#/components/schemas/Interaction' contents: type: object description: Used by managementservice snapshots - make sure not to break compatibility LoadThirdPartyApplicationResponse: type: object properties: app: $ref: '#/components/schemas/ThirdPartyApplication' TestUserGenerateOTPResponse: type: object properties: loginId: type: string code: type: string ConnectOutboundAppResponse: type: object properties: url: type: string ConfigureTenantSettingsRequest: type: object properties: tenantId: type: string domains: type: array items: type: string selfProvisioningDomains: type: array items: type: string authType: type: string enabled: type: boolean refreshTokenExpiration: type: integer format: int32 refreshTokenExpirationUnit: type: string sessionTokenExpiration: type: integer format: int32 sessionTokenExpirationUnit: type: string stepupTokenExpiration: type: integer format: int32 stepupTokenExpirationUnit: type: string enableInactivity: type: boolean inactivityTime: type: integer format: int32 inactivityTimeUnit: type: string JITDisabled: type: boolean ssoSetupSuiteSettings: $ref: '#/components/schemas/SSOSetupSuiteSettings' Project: type: object properties: id: type: string name: type: string tag: type: string environment: type: string tags: type: array items: type: string ConfigureSSORedirectURLRequest: type: object properties: tenantId: type: string samlRedirectUrl: type: string oauthRedirectUrl: type: string ssoId: type: string LoadSchemaResponse: type: object properties: schema: $ref: '#/components/schemas/Schema' RoleItem: type: object properties: id: type: string name: type: string UserPasskey: type: object properties: id: type: string rpId: type: string kind: type: string displayName: type: string createdTime: type: integer format: int32 ImportMessagingLocalizationRequest: type: object properties: overrides: $ref: '#/components/schemas/TemplateLocalizationOverrides' TargetsRelationsRequest: type: object properties: targets: type: array items: type: string includeTargetSetRelations: type: boolean ValidateJwtTemplateResponse: type: object properties: valid: type: boolean issues: type: array items: $ref: '#/components/schemas/JwtTemplateValidationIssue' AssociatedTenantAK: type: object properties: tenantId: type: string roleNames: type: array items: type: string tenantName: type: string UserMapping: type: object properties: name: type: string email: type: string username: type: string group: type: string givenName: type: string middleName: type: string familyName: type: string picture: type: string customAttributes: type: object additionalProperties: type: string verifiedEmail: type: string verifiedPhone: type: string AccessKeysResponse: type: object properties: keys: type: array items: $ref: '#/components/schemas/AccessKey' ReBACGroupsMapping: type: object properties: relations: type: array items: $ref: '#/components/schemas/ReBACGroupsMappingRelation' UpdateOutboundAppResponse: type: object properties: app: $ref: '#/components/schemas/OutboundApp' CreateDynamicRegistrationTemplateResponse: type: object properties: template: $ref: '#/components/schemas/DynamicRegistrationTemplate' BatchCreateResourcePoliciesRequest: type: object properties: policies: type: array items: $ref: '#/components/schemas/CreateResourcePolicyRequest' description: Batch resource policy operations ThirdPartyApplicationConsent: type: object properties: id: type: string appId: type: string userId: type: string scopes: type: array items: type: string grantedBy: type: string createdTime: type: integer format: int32 tenantId: type: string ExpireTime: type: integer format: int32 modifiedTime: type: integer format: int32 ResourceDetails: type: object properties: resourceId: type: string resourceType: type: string displayName: type: string EmbeddedLinkSignInResponse: type: object properties: token: type: string maskedEmail: type: string maskedPhone: type: string LoadAllThirdPartyApplicationsResponse: type: object properties: apps: type: array items: $ref: '#/components/schemas/ThirdPartyApplication' total: type: integer format: int32 DescoperTagRole: type: object properties: tags: type: array items: type: string role: type: string Node: type: object properties: nType: type: string description: Node type can be either child, union, intersect or sub children: type: array items: $ref: '#/components/schemas/Node' description: For union, intersect or sub, the children nodes expression: allOf: - $ref: '#/components/schemas/NodeExpression' description: The expression for child nodes SamlSettingsResponse: type: object properties: idpEntityId: type: string idpSSOUrl: type: string idpCertificate: type: string idpMetadataUrl: type: string spEntityId: type: string spACSUrl: type: string spCertificate: type: string attributeMapping: $ref: '#/components/schemas/UserMapping' groupsMapping: type: array items: $ref: '#/components/schemas/GroupsMapping' redirectUrl: type: string spSignCertificate: type: string subjectNameIdFormat: type: string defaultSSORoles: type: array items: type: string fgaMappings: type: object additionalProperties: $ref: '#/components/schemas/ReBACGroupsMapping' providerID: type: string scimProviderID: type: string configFGATenantIDResourcePrefix: type: string configFGATenantIDResourceSuffix: type: string idpAdditionalCertificates: type: array items: type: string groupsPriority: type: array items: type: string ManagementKey: type: object properties: id: type: string name: type: string description: type: string status: type: string createdTime: type: integer format: int32 expireTime: type: integer format: int32 permittedIps: type: array items: type: string reBac: $ref: '#/components/schemas/ManagementKeyReBac' version: type: integer format: int32 authzVersion: type: integer format: int32 CreateSSOApplicationResponse: type: object properties: id: type: string GroupsMapping: type: object properties: role: $ref: '#/components/schemas/RoleItem' groups: type: array items: type: string UsersAuthHistoryResponse: type: object properties: usersAuthHistory: type: array items: $ref: '#/components/schemas/UserAuthHistory' DeleteTuplesRequest: type: object properties: tuples: type: array items: $ref: '#/components/schemas/Tuple' ExportFlowResponse: type: object properties: flow: $ref: '#/components/schemas/ExportedFlow' ConnectOutboundAppRequest: type: object properties: appId: type: string options: $ref: '#/components/schemas/ConnectOutboundAppOptions' ListProjectsResponse: type: object properties: projects: type: array items: $ref: '#/components/schemas/Project' SearchFlowsRequest: type: object properties: ids: type: array items: type: string DeleteManagementKeysRequest: type: object properties: ids: type: array items: type: string SSOSAMLByMetadataSettings: type: object properties: idpMetadataUrl: type: string roleMappings: type: array items: $ref: '#/components/schemas/RoleMapping' attributeMapping: $ref: '#/components/schemas/AttributeMapping' spEncryptionKey: type: string spSignKey: type: string subjectNameIdFormat: type: string spACSUrl: type: string spEntityId: type: string defaultSSORoles: type: array items: type: string fgaMappings: type: object additionalProperties: $ref: '#/components/schemas/ReBACGroupsMapping' configFGATenantIDResourcePrefix: type: string configFGATenantIDResourceSuffix: type: string groupsPriority: type: array items: type: string UpdateResourcePolicyRequest: type: object properties: resourceId: type: string thirdPartyApplicationId: type: string userAccessScopes: type: array items: type: string clientAccessScopes: type: array items: type: string allUserScopes: type: boolean allClientScopes: type: boolean UserResponse: type: object properties: user: $ref: '#/components/schemas/ResponseUser' created: type: boolean CreateOutboundAppByTemplateRequest: type: object properties: clientId: type: string clientSecret: type: string tenantId: type: string id: type: string overrides: $ref: '#/components/schemas/CreateOutboundAppByTemplateOverrides' SaveRelationDefinitionResponse: type: object properties: {} CreateOutboundAppByTemplateOverrides: type: object properties: name: type: string description: type: string logo: type: string discoveryUrl: type: string authorizationUrl: type: string authorizationUrlParams: type: array items: $ref: '#/components/schemas/URLParam' tokenUrl: type: string tokenUrlParams: type: array items: $ref: '#/components/schemas/URLParam' revocationUrl: type: string defaultScopes: type: array items: type: string defaultRedirectUrl: type: string callbackDomain: type: string pkce: type: boolean accessType: type: string prompt: type: array items: type: string useDcr: type: boolean dcrUrl: type: string DeleteDescoperResponse: type: object properties: {} JwtTemplateValidationIssue: type: object properties: field: type: string code: type: string message: type: string hint: type: string description: "Single validation failure produced by ValidateJwtTemplate. `code` is a\n stable identifier callers (e.g. MCP agents) can pattern-match on." AccessKeyRequest: type: object properties: id: type: string DescoperRBAC: type: object properties: isCompanyAdmin: type: boolean tags: type: array items: $ref: '#/components/schemas/DescoperTagRole' projects: type: array items: $ref: '#/components/schemas/DescoperProjectRole' CreateResourceRequest: type: object properties: name: type: string scopes: $ref: '#/components/schemas/DynamicClientRegistrationApprovedScopes' userAccess: type: string clientAccess: type: string description: type: string uri: type: string type: type: string dynamicRegistrationSettings: $ref: '#/components/schemas/DynamicRegistrationSettings' Input: type: object properties: type: type: string name: type: string required: type: boolean visible: type: boolean displayName: type: string displayType: type: string dependsOn: type: array items: type: string nameValueMap: type: object contextAware: type: boolean options: type: array items: $ref: '#/components/schemas/Option' defaultValue: type: string helperText: type: string DeleteResourceRelationsForResourcesRequest: type: object properties: resources: type: array items: type: string AccessKeyBatchRequest: type: object properties: ids: type: array items: type: string RunManagementFlowAsyncResponse: type: object properties: executionId: type: string DeleteOutboundAppResponse: type: object properties: {} CreateTenantResponse: type: object properties: id: type: string UpdateUserRequest: type: object properties: loginId: type: string email: type: string phone: type: string verifiedEmail: type: boolean verifiedPhone: type: boolean name: type: string roleNames: type: array items: type: string userTenants: type: array items: $ref: '#/components/schemas/managementv1.AssociatedTenant' customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value picture: type: string additionalIdentifiers: type: array items: type: string givenName: type: string middleName: type: string familyName: type: string ssoAppIds: type: array items: type: string status: type: string recoveryEmail: type: string recoveryPhone: type: string verifiedRecoveryEmail: type: boolean verifiedRecoveryPhone: type: boolean McpServerClient: type: object properties: id: type: string name: type: string clientId: type: string mcpServerId: type: string approvedCallbackUrls: type: array items: type: string scopes: type: array items: type: string tags: type: array items: type: string logo: type: string registrationType: type: string status: type: string forceAddAllAuthorizationInfo: type: boolean allowedTenants: type: array items: type: string UpdateProjectNameRequest: type: object properties: name: type: string DeleteThirdPartyApplicationTenantConsentsRequest: type: object properties: consentIds: type: array items: type: string appId: type: string tenantId: type: string LoadAllMcpServersResponse: type: object properties: servers: type: array items: $ref: '#/components/schemas/McpServer' total: type: integer format: int32 TrustedDevice: type: object properties: id: type: string name: type: string deviceType: type: string userId: type: string lastLoginTime: type: string expirationTime: type: string lastLocation: type: string isCurrentDevice: type: boolean description: expands userv1.TrustedDevice with isCurrentDevice TestUserGenerateEnchantedLinkRequest: type: object properties: loginId: type: string redirectUrl: type: string loginOptions: $ref: '#/components/schemas/LoginOptions' CloneProjectRequest: type: object properties: name: type: string environment: type: string tags: type: array items: type: string LoadGroupsResponse: type: object properties: groups: type: array items: $ref: '#/components/schemas/Group' SetUserPasswordResponse: type: object properties: cleartext: type: string UpdateTenantRequest: type: object properties: id: type: string name: type: string selfProvisioningDomains: type: array items: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value authType: type: string description: deprecated - authType should be set via ConfigureTenantSettings disabled: type: boolean enforceSSO: type: boolean enforceSSOExclusions: type: array items: type: string federatedAppIds: type: array items: type: string roleInheritance: type: string LoadAllDynamicRegistrationTemplatesResponse: type: object properties: templates: type: array items: $ref: '#/components/schemas/DynamicRegistrationTemplate' total: type: integer format: int32 DynamicClientRegistrationApprovedScopes: type: object properties: permissionsScopes: type: array items: $ref: '#/components/schemas/projectv1.ApplicationScope' attributesScopes: type: array items: $ref: '#/components/schemas/projectv1.ApplicationScope' connectionsScopes: type: array items: $ref: '#/components/schemas/projectv1.ApplicationScope' Resource: type: object properties: id: type: string version: type: string name: type: string scopes: $ref: '#/components/schemas/DynamicClientRegistrationApprovedScopes' createdTime: type: string modifiedTime: type: string userAccess: type: string clientAccess: type: string description: type: string uri: type: string type: type: string dynamicRegistrationSettings: $ref: '#/components/schemas/DynamicRegistrationSettings' description: Resource CRUD messages ExportedFlowTranslation: type: object properties: enabled: type: boolean connectorId: type: string sourceLanguage: type: string targetLanguages: type: array items: type: string description: Used by managementservice snapshots - make sure not to break compatibility SSOSetupSuiteSettingsDisabledFeatures: type: object properties: saml: type: boolean oidc: type: boolean scim: type: boolean ssoDomains: type: boolean groupMapping: type: boolean ManagementFlowOptions: type: object properties: input: type: object preview: type: boolean tenant: type: string RemoveSSOSuffixFromExternalIdRequest: type: object properties: tenantId: type: string CreateOutboundAppResponse: type: object properties: app: $ref: '#/components/schemas/OutboundApp' MappableResourceQuery: type: object properties: type: type: string queries: type: array items: type: string SearchTenantsRequest: type: object properties: tenantIds: type: array items: type: string tenantNames: type: array items: type: string tenantSelfProvisioningDomains: type: array items: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value authType: type: string tenantSSODomains: type: array items: type: string parentTenantId: type: string topLevelOnly: type: boolean ResourcePolicy: type: object properties: version: type: string thirdPartyApplicationId: type: string resourceId: type: string userAccessScopes: type: array items: type: string clientAccessScopes: type: array items: type: string allUserScopes: type: boolean allClientScopes: type: boolean createdTime: type: string modifiedTime: type: string description: ResourcePolicy CRUD messages ResourceRelationsResponse: type: object properties: relations: type: array items: $ref: '#/components/schemas/Relation' DeleteMcpServersResponse: type: object properties: {} UpdateResourcePolicyResponse: type: object properties: resourcePolicy: $ref: '#/components/schemas/ResourcePolicy' JwtTemplateResponse: type: object properties: template: $ref: '#/components/schemas/JWTTemplate' DeleteResourceRequest: type: object properties: id: type: string ListUserOutboundAppsWithValidUserTokenResponse: type: object properties: appIds: type: array items: type: string HasRelationsResponse: type: object properties: relationQueries: type: array items: $ref: '#/components/schemas/RelationQuery' directRelations: type: array items: type: boolean SaveSchemaRequest: type: object properties: schema: $ref: '#/components/schemas/Schema' upgrade: type: boolean DeleteAllTestUsersResponse: type: object properties: {} LoadAllSSOApplicationsResponse: type: object properties: apps: type: array items: $ref: '#/components/schemas/SSOApplication' CreateResourcePolicyRequest: type: object properties: thirdPartyApplicationId: type: string resourceId: type: string userAccessScopes: type: array items: type: string clientAccessScopes: type: array items: type: string allUserScopes: type: boolean allClientScopes: type: boolean StopImpersonationRequest: type: object properties: jwt: type: string selectedTenant: type: string customClaims: type: object description: Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans. additionalProperties: type: string example: claim-name: claim-value refreshDuration: type: integer format: int32 CreateUsersRequest: type: object properties: users: type: array items: $ref: '#/components/schemas/CreateUsers' invite: type: boolean sendMail: type: boolean sendSMS: type: boolean inviteUrl: type: string templateOptions: type: object additionalProperties: type: string SearchRolesRequest: type: object properties: tenantIds: type: array items: type: string roleNames: type: array items: type: string roleNameLike: type: string permissionNames: type: array items: type: string text: type: string description: Full text search across relevant columns sort: type: array items: $ref: '#/components/schemas/SortField' includeProjectRoles: type: boolean description: relevant when tenantIds are set roleIds: type: array items: type: string DeleteDynamicRegistrationTemplateRequest: type: object properties: id: type: string UpdateUserCustomAttributeRequest: type: object properties: loginId: type: string attributeKey: type: string attributeValue: $ref: '#/components/schemas/google.protobuf.Value' DeleteResourcePolicyRequest: type: object properties: resourceId: type: string thirdPartyApplicationId: type: string ListTrustedDevicesForUsersRequest: type: object properties: identifiers: type: array items: type: string description: The users' login identifiers (external ID or ID). OAuthUserDataClaimsMapping: type: object properties: loginId: type: string username: type: string name: type: string email: type: string verifiedEmail: type: string verifiedPhone: type: string picture: type: string givenName: type: string middleName: type: string familyName: type: string customAttributes: type: object additionalProperties: type: string group: type: string description: "Note that this is used both in SSO settings and in OAuth settings import/export,\n make sure not to change any fields which might break backwards compatibility with\n existing exported project data" SSOSAMLSettings: type: object properties: idpUrl: type: string entityId: type: string idpCert: type: string roleMappings: type: array items: $ref: '#/components/schemas/RoleMapping' attributeMapping: $ref: '#/components/schemas/AttributeMapping' spEncryptionKey: type: string spSignKey: type: string subjectNameIdFormat: type: string spACSUrl: type: string spEntityId: type: string defaultSSORoles: type: array items: type: string fgaMappings: type: object additionalProperties: $ref: '#/components/schemas/ReBACGroupsMapping' configFGATenantIDResourcePrefix: type: string configFGATenantIDResourceSuffix: type: string idpAdditionalCerts: type: array items: type: string groupsPriority: type: array items: type: string UpdateUserLoginIDRequest: type: object properties: loginId: type: string newLoginId: type: string SearchUsersRequest: type: object properties: loginId: type: string description: Search for specific login ID tenantIds: type: array items: type: string description: If not empty then users must be members of at least one of these tenants roleNames: type: array items: type: string description: If not empty then users must have one of the specified roles limit: type: integer description: Default is 100 if not specified format: int32 text: type: string description: Full text search across relevant columns page: type: integer description: Page number starting with 0 for the first page format: int32 ssoOnly: type: boolean description: Bring only users that have SSO external IDs default: false withTestUser: type: boolean description: Return also users which are test users testUsersOnly: type: boolean description: Return only test users default: false customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value statuses: type: array items: type: string description: If not empty then users must be in one of those statuses emails: type: array items: type: string phones: type: array items: type: string ssoAppIds: type: array items: type: string sort: type: array items: $ref: '#/components/schemas/SortField' loginIds: type: array items: type: string fromCreatedTime: type: string toCreatedTime: type: string fromModifiedTime: type: string toModifiedTime: type: string userIds: type: array items: type: string scimOnly: type: boolean description: Bring only users that provisioned or updated by SCIM tenantRoleIds: type: object additionalProperties: $ref: '#/components/schemas/StringArray' tenantRoleNames: type: object additionalProperties: $ref: '#/components/schemas/StringArray' includeSubTenants: type: boolean password: type: boolean totp: type: boolean webauthn: type: boolean scim: type: boolean selectedColumns: type: array items: type: string verifiedEmail: type: boolean description: If provided, filter users by whether their email is verified verifiedPhone: type: boolean description: If provided, filter users by whether their phone is verified offset: type: integer description: "Direct row offset for pagination (0-based). When set to a positive value,\n this takes precedence over the page-based offset (page * limit)." format: int32 recoveryEmails: type: array items: type: string description: If not empty then users must have one of the specified recovery emails (exact match) recoveryPhones: type: array items: type: string description: If not empty then users must have one of the specified recovery phones (exact match) verifiedRecoveryEmail: type: boolean description: If provided, filter users by whether their recovery email is verified verifiedRecoveryPhone: type: boolean description: If provided, filter users by whether their recovery phone is verified ResourcePolicyIdentifier: type: object properties: resourceId: type: string thirdPartyApplicationId: type: string SearchThirdPartyApplicationConsentsRequest: type: object properties: appId: type: string userId: type: string consentId: type: string page: type: integer description: Page number starting with 0 for the first page format: int32 tenantId: type: string limit: type: integer format: int32 DeleteMcpServerClientsRequest: type: object properties: ids: type: array items: type: string mcpServerId: type: string CreateOutboundAppByDcrPresetRequest: type: object properties: dcrPresetId: type: string tenantId: type: string ConnectOutboundAppOptions: type: object properties: redirectUrl: type: string scopes: type: array items: type: string prompt: type: array items: type: string loginHint: type: string resources: type: array items: type: string externalIdentifier: type: string Option: type: object properties: value: type: string label: type: string LoadJwtTemplateRequest: type: object properties: id: type: string FlowTemplate: type: object properties: id: type: string name: type: string description: type: string dsl: type: object modifiedTime: type: string etag: type: string tags: type: array items: type: string methods: type: array items: type: string screens: type: array items: $ref: '#/components/schemas/FlowTemplateScreen' keywords: type: array items: type: string DeletePermissionsRequest: type: object properties: names: type: array items: type: string ids: type: array items: type: string description: Permission IDs — can be combined with names or used alone. Namespace: type: object properties: name: type: string description: Name of the namespace (entity type) relationDefinitions: type: array items: $ref: '#/components/schemas/RelationDefinition' description: The relation definitions belonging to the namespace ValidateJwtTemplateRequest: type: object properties: template: $ref: '#/components/schemas/JWTTemplate' id: type: string GenerateTenantAdminLinkResponse: type: object properties: adminSSOConfigurationLink: type: string FetchLatestOutboundAppUserTokenRequest: type: object properties: appId: type: string userId: type: string tenantId: type: string options: $ref: '#/components/schemas/FetchOutboundAppTokenOptions' externalIdentifier: type: string ListFlowsResponse: type: object properties: flows: type: array items: $ref: '#/components/schemas/Flow' total: type: integer format: int32 CIMDDomainPolicy: type: object properties: domainPattern: type: string enabled: type: boolean UpdateUserRecoveryEmailRequest: type: object properties: loginId: type: string recoveryEmail: type: string verified: type: boolean CreateUpdateSSOSAMLApplicationRequest: type: object properties: id: type: string name: type: string description: type: string enabled: type: boolean logo: type: string loginPageUrl: type: string useMetadataInfo: type: boolean metadataUrl: type: string entityId: type: string acsUrl: type: string certificate: type: string attributeMapping: type: array items: $ref: '#/components/schemas/SAMLIDPAttributeMappingInfo' groupsMapping: type: array items: $ref: '#/components/schemas/SAMLIDPGroupsMappingInfo' acsAllowedCallbacks: type: array items: type: string subjectNameIdType: type: string subjectNameIdFormat: type: string defaultRelayState: type: string forceAuthentication: type: boolean logoutRedirectUrl: type: string errorRedirectUrl: type: string defaultSignatureAlgorithm: type: string SendTenantAdminLinkRequest: type: object properties: tenantId: type: string email: type: string ssoId: type: string UpdateRolesRequest: type: object properties: roles: type: array items: $ref: '#/components/schemas/UpdateRoleRequest' ExportedFlow: type: object properties: flowId: type: string metadata: $ref: '#/components/schemas/ExportedFlowMetadata' contents: type: object screens: type: array items: $ref: '#/components/schemas/ExportedScreen' references: $ref: '#/components/schemas/ProjectReferences' description: Used by managementservice snapshots - make sure not to break compatibility CreateRoleRequest: type: object properties: name: type: string description: type: string permissionNames: type: array items: type: string tenantId: type: string default: type: boolean private: type: boolean BatchDeleteResourcePoliciesRequest: type: object properties: policies: type: array items: $ref: '#/components/schemas/ResourcePolicyIdentifier' SignUpUser: type: object properties: loginId: type: string name: type: string phone: type: string email: type: string givenName: type: string middleName: type: string familyName: type: string recoveryEmail: type: string recoveryPhone: type: string IDPResponse: type: object properties: samlResponse: type: string samlGeneratedUser: type: string samlGeneratedRoles: type: string oidcResponse: type: string oidcGeneratedUser: type: string oidcGeneratedRoles: type: string idpGroups: type: array items: type: string idpSAMLAttributes: type: object default: false idpOIDCClaims: type: object GetTenantAdminLinkSSOForAuthenticateUsersRequest: type: object properties: tenantId: type: string SearchAccessKeysRequest: type: object properties: tenantIds: type: array items: type: string text: type: string sort: type: array items: $ref: '#/components/schemas/SortField' boundUserId: type: string creatingUser: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value CreateResourcePolicyResponse: type: object properties: resourcePolicy: $ref: '#/components/schemas/ResourcePolicy' UpdateManagementKeyResponse: type: object properties: key: $ref: '#/components/schemas/ManagementKey' CreateThirdPartyApplicationRequest: type: object properties: name: type: string description: type: string logo: type: string loginPageUrl: type: string approvedCallbackUrls: type: array items: type: string permissionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' attributesScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' consentFlowId: type: string logoUrl: type: string jwtBearerSettings: allOf: - $ref: '#/components/schemas/JWTBearerSettings' description: 'string backChannelLogoutUrl = 10 [(validate).string = {url: true, optional: true}];' sessionSettings: $ref: '#/components/schemas/managementv1.ThirdPartyApplicationSessionSettings' nonConfidentialClient: type: boolean audienceWhitelist: type: array items: type: string clientId: type: string clientSecret: type: string forceAddAllAuthorizationInfo: type: boolean connectionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' defaultAudience: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value cibaSettings: $ref: '#/components/schemas/ThirdPartyApplicationCIBASettings' jarSettings: $ref: '#/components/schemas/ThirdPartyApplicationJARSettings' allowedTenants: type: array items: type: string CloneProjectAsyncResponse: type: object properties: processId: type: string DeletePermissionRequest: type: object properties: name: type: string description: Either name or id must be provided (not both). id: type: string LoadUsersRequest: type: object properties: userIds: type: array items: type: string description: max len will be validated in app level, so we can control it with an env var includeInvalidUsers: type: boolean UploadOutboundAppUserAPIKeyResponse: type: object properties: {} LoadMemberGroupsRequest: type: object properties: tenantId: type: string loginIds: type: array items: type: string userIds: type: array items: type: string projectv1.ApplicationScope: type: object properties: name: type: string description: type: string optional: type: boolean values: type: array items: type: string description: Keep this message synchronized with the matching one in ManagementService IssuerSettings: type: object properties: jwksUri: type: string signAlgorithm: type: string userInfoUri: type: string externalIdFieldName: type: string SearchMcpServerClientsRequest: type: object properties: mcpServerId: type: string page: type: integer format: int32 limit: type: integer format: int32 text: type: string name: type: string clientId: type: string status: type: string registrationMethod: type: string tag: type: string sort: type: array items: $ref: '#/components/schemas/SortField' ListJwtTemplatesResponse: type: object properties: templates: type: array items: $ref: '#/components/schemas/JWTTemplate' ImportSnapshotRequest: type: object properties: files: type: object excludes: type: array items: type: string inputSecrets: $ref: '#/components/schemas/SnapshotSecrets' CreateRolesRequest: type: object properties: roles: type: array items: $ref: '#/components/schemas/CreateRoleRequest' CreateUsersFailureResponse: type: object properties: failure: type: string user: $ref: '#/components/schemas/ResponseUser' CheckResponseInfo: type: object properties: direct: type: boolean description: "A relation is considered \"direct\" if, based solely on the schema, its \"allowed\" state can only be\n changed by creating or deleting relations involving its resource, its target, or both (including itself)" path: allOf: - $ref: '#/components/schemas/CheckPath' description: if the check succeeded, includes the full path of intermediate relations between the target and the resource conditional: type: boolean description: true if the result was determined by evaluating a CEL condition missingContext: type: array items: type: string description: when the condition could not be fully evaluated, lists the missing context variable names conditionalErr: type: string description: "when CEL condition evaluation failed (e.g. invalid context value type), contains the error message;\n the check still returns 200 with allowed=false" UpdateThirdPartyApplicationRequest: type: object properties: id: type: string name: type: string description: type: string logo: type: string loginPageUrl: type: string approvedCallbackUrls: type: array items: type: string permissionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' attributesScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' logoUrl: type: string jwtBearerSettings: allOf: - $ref: '#/components/schemas/JWTBearerSettings' description: 'string backChannelLogoutUrl = 10 [(validate).string = {url: true, optional: true}];' sessionSettings: $ref: '#/components/schemas/managementv1.ThirdPartyApplicationSessionSettings' audienceWhitelist: type: array items: type: string forceAddAllAuthorizationInfo: type: boolean connectionsScopes: type: array items: $ref: '#/components/schemas/managementv1.ApplicationScope' defaultAudience: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value cibaSettings: $ref: '#/components/schemas/ThirdPartyApplicationCIBASettings' jarSettings: $ref: '#/components/schemas/ThirdPartyApplicationJARSettings' allowedTenants: type: array items: type: string CIMDDomainPolicies: type: object properties: policies: type: array items: $ref: '#/components/schemas/CIMDDomainPolicy' DeleteRelationsForResourcesRequest: type: object properties: resources: type: array items: type: string ExportMessagingLocalizationRequest: type: object properties: {} NodeExpression: type: object properties: neType: type: string description: Expression type can be either self, userSet, relationLeft, relationRight relationDefinition: type: string description: The name of the relation definition for self and relationLeft/Right relationDefinitionNamespace: type: string description: The namespace of the relation definition targetRelationDefinition: type: string description: The name of the relation definition for targetSet as well as type of relation for target relationLeft/Right targetRelationDefinitionNamespace: type: string description: The namespace of the target relation definition WhatCanTargetAccessWithRelationResponse: type: object properties: resources: type: array items: type: string NewSSOSettingsRequest: type: object properties: tenantId: type: string ssoId: type: string displayName: type: string CreateUsers: type: object properties: loginId: type: string email: type: string phone: type: string verifiedEmail: type: boolean verifiedPhone: type: boolean name: type: string roleNames: type: array items: type: string userTenants: type: array items: $ref: '#/components/schemas/managementv1.AssociatedTenant' test: type: boolean default: false picture: type: string customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value password: type: string hashedPassword: $ref: '#/components/schemas/PasswordImport' additionalIdentifiers: type: array items: type: string givenName: type: string middleName: type: string familyName: type: string ssoAppIds: type: array items: type: string seed: type: string status: type: string createdTime: type: integer format: int32 recoveryEmail: type: string recoveryPhone: type: string verifiedRecoveryEmail: type: boolean verifiedRecoveryPhone: type: boolean LoadDSLSchemaResponse: type: object properties: dsl: type: string schema: $ref: '#/components/schemas/Schema' Widget: type: object properties: widgetId: type: string name: type: string type: type: string disabled: type: boolean UpdateMcpServerResponse: type: object properties: server: $ref: '#/components/schemas/McpServer' EmbeddedLinkSignUpOrInRequest: type: object properties: loginId: type: string loginOptions: $ref: '#/components/schemas/LoginOptions' user: $ref: '#/components/schemas/SignUpUser' emailVerified: type: boolean phoneVerified: type: boolean timeout: type: integer format: int32 DeleteTenantRequest: type: object properties: id: type: string cascade: type: boolean CheckTextInListResponse: type: object properties: exists: type: boolean WhatCanTargetAccessResponse: type: object properties: relations: type: array items: $ref: '#/components/schemas/Relation' OutboundApp: type: object properties: id: type: string name: type: string description: type: string clientId: type: string logo: type: string discoveryUrl: type: string authorizationUrl: type: string authorizationUrlParams: type: array items: $ref: '#/components/schemas/URLParam' tokenUrl: type: string tokenUrlParams: type: array items: $ref: '#/components/schemas/URLParam' revocationUrl: type: string defaultScopes: type: array items: type: string defaultRedirectUrl: type: string callbackDomain: type: string pkce: type: boolean accessType: type: string prompt: type: array items: type: string clientSecret: type: string appType: type: string useDcr: type: boolean dcrUrl: type: string tenantId: type: string UpdateDynamicRegistrationTemplateRequest: type: object properties: template: $ref: '#/components/schemas/DynamicRegistrationTemplate' UpdateListResponse: type: object properties: list: $ref: '#/components/schemas/List' CreateRelationsResponse: type: object properties: {} Condition: type: object properties: name: type: string params: type: array items: $ref: '#/components/schemas/ConditionParam' expression: type: string builtin: type: boolean description: true for conditions auto-expanded from built-in constraint declarations UsersAuthHistoryRequest: type: object properties: userIds: type: array items: type: string GetMcpServerClientSecretRequest: type: object properties: id: type: string mcpServerId: type: string CompleteExternalAuthResponse: type: object properties: redirectUrl: type: string GetTenantSettingsResponse: type: object properties: domains: type: array items: type: string selfProvisioningDomains: type: array items: type: string authType: type: string enabled: type: boolean refreshTokenExpiration: type: integer format: int32 refreshTokenExpirationUnit: type: string sessionTokenExpiration: type: integer format: int32 sessionTokenExpirationUnit: type: string stepupTokenExpiration: type: integer format: int32 stepupTokenExpirationUnit: type: string enableInactivity: type: boolean inactivityTime: type: integer format: int32 inactivityTimeUnit: type: string JITDisabled: type: boolean ssoSetupSuiteSettings: $ref: '#/components/schemas/SSOSetupSuiteSettings' CreateListRequest: type: object properties: name: type: string description: type: string type: type: string data: $ref: '#/components/schemas/google.protobuf.Value' Schema: type: object properties: namespaces: type: array items: $ref: '#/components/schemas/Namespace' description: List of namespaces in the schema name: type: string conditions: type: array items: $ref: '#/components/schemas/Condition' description: Conditions defined in the schema SnapshotSecrets: type: object properties: connectors: type: array items: $ref: '#/components/schemas/SnapshotSecret' oauthProviders: type: array items: $ref: '#/components/schemas/SnapshotSecret' outboundApps: type: array items: $ref: '#/components/schemas/SnapshotSecret' externalAuth: type: array items: $ref: '#/components/schemas/SnapshotSecret' CheckIPInListResponse: type: object properties: exists: type: boolean SaveNamespaceRequest: type: object properties: namespace: $ref: '#/components/schemas/Namespace' oldName: type: string description: Old name if we are renaming the namespace schemaName: type: string description: optional upgrade to the schema name ResponseUser: type: object properties: loginIds: type: array items: type: string userId: type: string name: type: string email: type: string phone: type: string verifiedEmail: type: boolean verifiedPhone: type: boolean roleNames: type: array items: type: string userTenants: type: array items: $ref: '#/components/schemas/UserTenants' status: type: string externalIds: type: array items: type: string picture: type: string test: type: boolean default: false customAttributes: type: object description: Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. additionalProperties: type: string example: attribute-key: attribute-value createdTime: type: integer format: int32 TOTP: type: boolean default: false SAML: type: boolean default: false OAuth: type: object additionalProperties: type: boolean default: false webauthn: type: boolean password: type: boolean ssoAppIds: type: array items: type: string givenName: type: string middleName: type: string familyName: type: string editable: type: boolean SCIM: type: boolean push: type: boolean permissions: type: array items: type: string OIDC: type: boolean consentExpiration: type: integer format: int32 recoveryEmail: type: string verifiedRecoveryEmail: type: boolean recoveryPhone: type: string verifiedRecoveryPhone: type: boolean JWTTemplateLibraryEntry: type: object properties: id: type: string name: type: string description: type: string template: type: object tags: type: array items: type: string authSchema: type: string type: type: string conformanceIssuer: type: boolean autoDCT: type: boolean enforceIssuer: type: boolean emptyClaimPolicy: type: string overrideSubject: type: boolean issuerType: type: string omitCustomClaimsFromDSR: type: boolean addJti: type: boolean excludePermissions: type: boolean experimental: type: boolean logoLight: type: string logoDark: type: string description: "Library entry — read-only starter shipped by Descope. Mirrors the `key`\n fields of JWTTemplate plus library-only metadata." RestoreBackupRequest: type: object properties: backupId: type: string ImportFlowLocalizationResponse: type: object properties: overrides: $ref: '#/components/schemas/FlowLocalizationOverrides' SSOOIDCSettings: type: object properties: name: type: string clientId: type: string clientSecret: type: string redirectUrl: type: string authUrl: type: string tokenUrl: type: string userDataUrl: type: string scope: type: array items: type: string JWKsUrl: type: string userAttrMapping: $ref: '#/components/schemas/OAuthUserDataClaimsMapping' manageProviderTokens: type: boolean callbackDomain: type: string prompt: type: array items: type: string grantType: type: string issuer: type: string groupsMapping: type: array items: $ref: '#/components/schemas/GroupsMapping' defaultSSORoles: type: array items: type: string fgaMappings: type: object additionalProperties: $ref: '#/components/schemas/ReBACGroupsMapping' roleMappings: type: array items: $ref: '#/components/schemas/RoleMapping' providerID: type: string scimProviderID: type: string groupsPriority: type: array items: type: string MappableResource: type: object properties: resource: type: string displayName: type: string DeleteRelationDefinitionResponse: type: object properties: {} CheckTextInListRequest: type: object properties: id: type: string text: type: string UpdateUserRemoveTrustedDevicesRequest: type: object properties: loginId: type: string description: The user's login identifier (external ID) or ID deviceIds: type: array items: type: string description: Trusted device IDs to delete securitySchemes: Descope Project ID: type: http scheme: bearer bearerFormat: Project ID description: Project ID as bearer token. Descope Project ID:Refresh JWT: type: http scheme: bearer bearerFormat: Project ID:Refresh JWT description: Project ID:Refresh JWT as bearer token. Descope Project ID:Access Key: type: http scheme: bearer bearerFormat: ProjectId:AccessKey description: Project ID:Access Key as bearer token. Descope Project ID:Session JWT: type: http scheme: bearer bearerFormat: Project ID:Session JWT description: Project ID:Session JWT as bearer token. Descope Project ID and Management Key: type: http description: Project ID:Management Key as bearer token. scheme: bearer bearerFormat: ProjectId:ManagementKey externalDocs: description: Descope Server url: https://docs.descope.com