Users API
Private Beta
Agent Identity is available as a Private Beta product, and the information contained in this document is subject to change. You acknowledge and agree that your use of Agent Identity is subject to the terms of the Services in Private Beta. Some features are not yet implemented and others may change before the product is declared as Generally Available. Private Beta products are not covered by the Twilio Support Terms or Twilio Service Level Agreement.
Agent Identity tracks the relationships between your users and the clients they've authorized. You can query and manage these relationships through the API and view them in the Console.
A user record is created automatically the first time a user completes the Trusted Auth Token flow, and updated on later sign-ins. Each user carries the subject from your system, the scopes the user may grant, and the custom claims from the Trusted Auth Token.
| Operation | Method and path | Description |
|---|---|---|
| List users | GET /v1/Users | Retrieve a paginated list of users. |
| Get user | GET /v1/Users/{userId} | Retrieve a single user by ID. |
| Delete user | DELETE /v1/Users/{userId} | Delete a user. |
| List authorizations | GET /v1/Users/{userId}/Authorizations | Retrieve a paginated list of the clients a user has authorized and the scopes granted. |
| Delete authorization | DELETE /v1/Users/{userId}/Authorizations/{clientId} | Revoke a user's authorization for a client. This also revokes the refresh tokens issued to that client for that user. Note that a clientId can be a URL. |