Permission

Get grant

Changed on

Get a grant by its ID.

get/v1/permissions/{id}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/permissions/{id}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token)

Response

OK

idstring required

Unique identifier of the grant.

principalstring required

ID of the principal that holds the grant.

principal_type'Assignment' | 'Attachment' | 'Comment' | 'Document' | 'Issue' | 'IssueRelation' | 'Label' | 'Namespace' | 'Notification' | 'Organization' | 'Permission' | 'Project' | 'ResourceType' | 'Role' | 'Team' | 'Todo' | 'User' | 'UserToken' | 'Folder' | 'Installation' | 'CustomFieldDefinition' | 'Extension' required
scopestring required

ID of the resource the grant applies to.

scope_type'Assignment' | 'Attachment' | 'Comment' | 'Document' | 'Issue' | 'IssueRelation' | 'Label' | 'Namespace' | 'Notification' | 'Organization' | 'Permission' | 'Project' | 'ResourceType' | 'Role' | 'Team' | 'Todo' | 'User' | 'UserToken' | 'Folder' | 'Installation' | 'CustomFieldDefinition' | 'Extension' required
role_idstring nullable required

ID of the role whose actions are included in this grant.

actionsAction[] required

Actions granted on the scope.

created_atstring date-time required

Date when the grant was created.

updated_atstring date-time nullable required

Date when the grant was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "principal": "9bsv0s46s6s002p9ltq0",
  "scope": "9bsv0s46s6s002p9ltq0",
  "role_id": "9bsv0s46s6s002p9ltq0"
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6c0b21e4101eRevision changes
    • warning

      added the new Extension enum value to the response property for the response status

    • warning

      added the new Extension enum value to the response property for the response status