Keystone Developers
Open Keystone
API reference

Auth service

Permissions

5 endpoints.

GET/api/v1/permissions/

List Permissions

List all permissions.

Parameters

NameInTypeDescription
skipqueryintegerdefault 0
limitqueryintegerdefault 100

Responses

200Successful Response
application/jsonPermissionResponse[]
FieldTypeDescription
keyrequiredstring
descriptionstring | null
idrequiredinteger
  • 422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/permissions/

Create Permission

Create new permission. Admin only.

Request bodyrequired

application/jsonPermissionCreate
FieldTypeDescription
keyrequiredstring
descriptionstring | null

Responses

201Successful Response
application/jsonPermissionResponse

PermissionResponse, expanded above.

  • 422Validation Error

Error bodies: HTTPValidationError. See Errors.

GET/api/v1/permissions/{permission_id}

Get Permission

Get permission by ID.

Parameters

NameInTypeDescription
permission_idrequiredpathinteger

Responses

200Successful Response
application/jsonPermissionResponse

PermissionResponse, expanded above.

  • 422Validation Error

Error bodies: HTTPValidationError. See Errors.

PUT/api/v1/permissions/{permission_id}

Update Permission

Update permission. Admin only.

Parameters

NameInTypeDescription
permission_idrequiredpathinteger

Request bodyrequired

application/jsonPermissionUpdate
FieldTypeDescription
keystring | null
descriptionstring | null

Responses

200Successful Response
application/jsonPermissionResponse

PermissionResponse, expanded above.

  • 422Validation Error

Error bodies: HTTPValidationError. See Errors.

DELETE/api/v1/permissions/{permission_id}

Delete Permission

Delete permission. Admin only.

Parameters

NameInTypeDescription
permission_idrequiredpathinteger

Responses

204Successful Response
  • 422Validation Error

Error bodies: HTTPValidationError. See Errors.