/purposes/{id}
Mount Point: /auth/api/v1/purposes/{id}/
The following operations are supported on this resource:
GET
Retrieve a specified purpose.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the purpose. | path |
Response Body
| result: | purpose |
| media types: | application/json |
The requested purpose.
Status Codes
| code | description |
|---|---|
| 200 | Success |
| 304 | Not modified |
| 404 | No such object |
PUT
Updates a purpose.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the purpose to be updated. | path |
Request Body
| element: | purpose |
| media types: | application/json |
The updated state.
Response Body
| result: | purpose |
| media types: | application/json |
Purpose updated purpose.
Status Codes
| code | description |
|---|---|
| 200 | Success |
| 412 | Precondition failed |
| 409 | Reserved for cache object out of date |
DELETE
Deletes the specified purpose.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the purpose to be deleted. | path |
Status Codes
| code | description |
|---|---|
| 204 | Success |
| 404 | No such object |