ATatlassian
Space Roles

Get space role by ID

Retrieves the space role by ID.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to access the Confluence site.

get/space-roles/{id}

Request

  • Base URL
    https://no-default/wiki/api/v2
  • URL
    https://no-default/wiki/api/v2/space-roles/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:space.permission:confluence

Path parameters

idinteger required

The ID of the space role to retrieve.

Response

Returned if the requested space role is retrieved.

idstring

The identifier for the space role.

type'SYSTEM' | 'CUSTOM'

The role type.

namestring

The name for the space role.

descriptionstring

The description for the space role’s usage.

spacePermissionsstring[]

The space permissions the space role is comprised of.

Changes

No recorded changes to this operation across all 5 revisions of this API.