rbac

List all groups

Lists all groups in the organization with the role IDs and user IDs assigned to each group.

get/rbac/groups

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
Scopesrbac|read
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/rbac/groups/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Groups in the organization.

descriptionstring

Detailed description of the group's purpose and scope

isManagedboolean

Whether the group is synced from your identity provider. You can't delete a managed group or change its members.

membersstring[]

List of user IDs that are assigned to this group

namestring required

Unique name identifier for the group

rolesstring[]

IDs of the roles assigned to the group. Use a custom role ID or a built-in role ID: axiom-owner, axiom-admin, axiom-user, axiom-read-only, or axiom-none.

idstring required

Unique identifier for the group

Changes

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

List all groups

Request

Response 200OK

Changes

Response