In this article
Delete Any Permissions which may exist for the given principal on the given subscription type
URL
https://{{HOST}}/subscriptiontype/{{type_id}}/permissions/{{principal}}
Method
DELETE
Required IMS Scopes
- subscription_write
- apollo_write
URL Path Parameters
| Name | Description | Example | Type |
|---|---|---|---|
| type_id required |
Type ID to revoke permission on | d8178fd0-35ed-499e-89ad-d5b13f0d4427 | string |
| principal | Principal ID to revoke permission for | sub:user:bob | string |
Request Header Parameters
| Type | Value | Description |
|---|---|---|
| Authorization required |
Bearer {access_token} | IMS access token |
| Content-Type required |
application/json | Content Type |
Example
Request
curl -X DELETE
'https://{{HOST}}/subscriptiontype/{{type_id}}/permissions/sub:user:bob'
-H 'Authorization: Bearer {access_token}'
Notes
- Use the following formats to define the subscriber:
- User = ‘sub:user:{{USERID}}’
- Application: ‘sub:app:{{APPID}}’
Errors
| Error | Description |
|---|---|
| 400 | Invalid delete, occurs when action would leave ACL in invalid state, ie, delete owner |
| 401 | Unauthorized |
| 403 | Forbiden. Possible causes: You do not have access to this endpoint (scope) You do not have access to this type |
| 404 | Type not found for id given |
| 504 | Timeout on request to storage repository |
Response Body Parameters
| Name | Description | Schema |
|---|---|---|
| id | Id of the type object | string |
| accesscontrolitems | Current list of access permissions for type | object definition |