Skip to main content
PATCH
Rename an SSO group

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null

The group's current ETag, required to guard against a concurrent update.

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

sso_group_id
string
required

Body

application/json
name
string | null

New name for the group. Because the name is the group's id, renaming moves it to a new URL. Omit to leave unchanged.

Minimum string length: 1

Response

Successful Response

A group from your identity provider, and a carrier for the roles its members receive when they log in.

A group is identified by its name: id and name always hold the same value. Renaming one therefore changes the other, and the group's URL with it.

id
string
required
read-only

The unique identifier of the group, which is its name.

name
string
required

The group name as it appears in your identity provider.

create_time
string
required
read-only

When the group's earliest role was granted — RFC 3339 UTC, e.g. 2026-06-05T10:30:00Z.

update_time
string
required
read-only

When any of the group's roles last changed — RFC 3339 UTC.

etag
string
required
read-only

Opaque strong ETag for optimistic concurrency.