Revoke User OAuth Scope Consent
PATCH {{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}
The PATCH /environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}} operation gives the actor the ability to revoke an OAuth scope consent for the specified user. This operation uses the application/vnd.pingidentity.consent.revoke+json custom content type in the request header.
Prerequisites
- See Users and User OAuth Scope Consents for important overview information.
For property descriptions, see OAuth scope consent data model.
| Property | Type | Required? |
|---|---|---|
status | String | Required |
Request Body
{"status"=>"REVOKED"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/oauthConsents/663a3fae-b0fa-4da3-a9ae-f2d60aebe56c"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32"}},"id":"663a3fae-b0fa-4da3-a9ae-f2d60aebe56c","application":{"id":"a4f6b7ed-95be-4dde-b5b5-dde152625b75"},"applicationName":"externalApp1","applicationType":"EXTERNAL","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"01dee5b5-48fa-4a6b-a574-f2ff28ab5b32"},"scope":["openid"],"status":"REVOKED","consentedAt":"2022-08-24T22:31:45.573Z","updatedAt":"2022-08-24T22:33:13.805Z"}