ATatlassian
Group

Get group

Returns a user group for a given group id.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

get/wiki/rest/api/group/by-id

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/group/by-id
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-groups

Query parameters

idstring required

The id of the group.

Response

Returned if the requested group is returned.

type'group' required
namestring required
idstring required
usageType'USERBASE_GROUP' | 'TEAM_COLLABORATION'

This property represents how this collection of users is used:

  • USERBASE_GROUP: This value indicates that the collection of users is used as a group.
  • TEAM_COLLABORATION: This value indicates that the collection of users is used as a team.
managedBy'ADMINS' | 'EXTERNAL' | 'TEAM_MEMBERS' | 'OPEN'

This property represents how this collection of users is managed:

  • ADMINS: This value indicates that the collection of users is managed by org, site or product admins.
  • EXTERNAL: This value indicates that the collection of users is managed externally (through SCIM, HRIS, etc.).
  • TEAM_MEMBERS: This value indicates that the collection of users is managed by its members.
  • OPEN: This value indicates that the collection of users is not actively managed by any users.
_linksGenericLinks

Changes

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