Single step revoke access

The flow is similar to the standard Revoke Access to A/S/F entities flow, except all the target information is provided in the initial Process Start request. The Process Start API optionally consumes no initial payload. Once the Process initializes, Digital Identity Management will respond with a request for the data it requires to complete its task. That data is then supplied by the client using the Process Step API, and this repeats until the task is complete. However, the Revoke Access Process is one of the few cases where your client can provide the required data upfront, in the initial Process Start request body. This can be useful if you want your UI to collect and retain the required data first before first before calling the Process. [product: dim]

[/product: dim]

Request

Once application has all the relevant information, it initalizes the Process with the Process Start API, and includes that information in the request body:

**POST https://\{your.url\}/process/start/entitlementManagement.RevokeUserAccess.v1.0**
{
   "parameters": {
      "userId": 93612,
      "entities": [
         {
            "entityType": "account",
            "entityId": 6007
         }
      ]
   }
} 

`parameters`	Object that specifies the info this Process requires to continue its task.
`userId`	The unique internal identifier of the target Digital Identity Management User (i.e., the `id` property) from whom to remove account/service access. Clients may obtain valid identifiers by using the relevant Group APIs (e.g. GET /group/{groupId}/users).
`entities`	Array of entities to be removed from target User. Each entity object includes:
`entityType`	The type of entity being shared. Possible values are `account`, `subscription`, and `feature`.
`entityId`	The unique internal identifier on the entity (i.e., the `id` property). A list of available entities along with their internal identifiers can be obtained by using the relevant APIs (e.g. GET /user/accounts, GET /user/subscriptions).

Process Complete

Provided all the information is accurate, Digital Identity Management removes any associations between the target User and the specified entities (Accounts, Subscriptions, Features). The Process completes and returns an HTTP status:

**RESPONSE - body**
{
   "processId": "a1fbea6f-6462-4138-b297-484a9be74af1",
   "processName": "entitlementManagement.RevokeUserAccess.v1.0",
   "lastStep": true,
} 

`processId`	Unique identifier for the current instance of this Process.
`processName`	Full name of the Process, including the category and version number.
`lastStep`	Boolean that indicates whether or not this was the last step in the Process.
Parent topic:Revoke Access to an Account, Subscription, or Feature Process

Home

Guides

APIs

Request

Process Complete

​Request

​Process Complete

Request

Process Complete