API ReferenceManagementInbound Apps
POST
/v1/mgmt/agentic/identities/xaa/block

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

consentIds*array<string>
string

Consent IDs of the agentic identities, as returned by SearchAgenticIdentities

Items1 <= items <= 100

Block XAA (ID-JAG) agentic identities by consent ID, using a valid management key. While an identity is blocked, token exchanges for it are rejected with an invalid_grant error. A block can take up to 5 minutes to apply, since the blocked state is cached. Blocking does not revoke the identity or delete its consent. Consent IDs are returned by the search agentic identities API. Returns the updated identities with their current blocked state. Only identities that were updated are returned; requested consent IDs that were not updated are listed in skippedConsentIds.

curl -X POST "https://api.descope.com/v1/mgmt/agentic/identities/xaa/block" \  -H "Content-Type: application/json" \  -d '{    "consentIds": [      "string"    ]  }'
{  "identities": [    {      "consent": {        "id": "string",        "appId": "string",        "userId": "string",        "scopes": [          "string"        ],        "grantedBy": "string",        "createdTime": 0,        "tenantId": "string",        "ExpireTime": 0,        "modifiedTime": 0,        "authMethod": "string",        "blocked": true      },      "agentName": "string",      "resourceId": "string",      "clientId": "string",      "createdBy": "string"    }  ],  "skippedConsentIds": [    "string"  ]}
export interface Response {identities?: AgenticIdentity[]/** * Requested consent IDs that were not updated: unknown IDs, and on block, consents that are not ID-JAG consents */skippedConsentIds?: string[]}export interface AgenticIdentity {consent?: {id: stringappId: stringuserId?: stringscopes?: string[]grantedBy?: stringcreatedTime?: numbertenantId?: stringExpireTime?: numbermodifiedTime?: number/** * Empty for an explicit consent, "idJag" for an identity recorded by a Cross-App Access exchange, which cannot be revoked */authMethod?: string/** * True when an admin blocked this "idJag" identity, so the user's ID-JAG exchanges for the application are rejected with invalid_grant */blocked?: boolean}agentName?: stringresourceId?: stringclientId?: stringcreatedBy?: string}
Was this helpful?