Groups
Deletes a group.
Successful deletion.
No content
Error object.
DELETE /api/v1/groups/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Updates a group.
Updates the display name of the group.
Updates the Group description, if a value is provided.
Sets the Roles that are bound to this Group to the Roles (specified by their names), if provided.
Adds the users/principals (specified by their names) to this group, if provided.
Removes the users/principals (specified by their names) from this group, if provided. If members are specified in both add_members as well in here, removal wins.
Sets the members of this group to those users/principals (specified by their names) in an absolute fashion, if provided. Cannot be combined with the add_members or remove_members fields.
Happy response.
Error object.
PATCH /api/v1/groups/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"display_name": "text",
"description": "text",
"roles": [
"text"
],
"add_members": [
"text"
],
"remove_members": [
"text"
],
"set_members": [
"text"
],
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"description": "text",
"roles": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"policy_length": 1,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"users": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"profile": {
"full_name": "text",
"email_address": "text"
},
"is_admin": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"service_accounts": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"is_admin": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Gets a group by its name.
Happy response.
Error object.
GET /api/v1/groups/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"description": "text",
"roles": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"policy_length": 1,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"users": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"profile": {
"full_name": "text",
"email_address": "text"
},
"is_admin": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"service_accounts": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"is_admin": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Creates a new Group.
Sets the unique name of the new group. It must be a valid HQ resource name: it can only contain lowercase alphanumeric characters or hyphens; hyphens cannot appear at the end or start; the length is 63 characters at most.
Sets the display name of the new group. If not provided, the value of "name" will be used.
Sets the description of the new group.
Lists principal names (users, service accounts) to be member of this group.
Sets the Roles that are bound to this Group by name.
Happy response.
Error object.
POST /api/v1/groups HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"name": "text",
"display_name": "text",
"description": "text",
"members": [
"text"
],
"roles": [
"text"
],
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"description": "text",
"roles": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"policy_length": 1,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"users": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"profile": {
"full_name": "text",
"email_address": "text"
},
"is_admin": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"service_accounts": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"is_admin": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Lists all groups
Happy response.
Error object.
GET /api/v1/groups HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-09-01T03:57:32.683Z",
"description": "text",
"user_count": 1,
"sa_count": 1,
"role_count": 1,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
}
Last updated
Was this helpful?