Update the admin group ID for an organization

Update the ID of the externally managed group that contains the organization's admins. Note that if the caller is not a member of the new group, they will lose admin access to the organization immediately.

Access control

Requires the caller to be an admin in the organization, or any of its ancestors.

Example: Assume an organization hierarchy like: org-a -> org-b -> org-c. To update the admin group ID for org-c, which means calling 'PUT /orgs/org-c/adminGroupId', the caller must be an admin in org-a, org-b or org-c.

Securityorg-oidc-token
Request
path Parameters
org
required
string (OrgId) [ 3 .. 64 ] characters ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

ID of an organization

Example: my-org
Request Body schema: text/plain
required

A request to update the admin group ID of an organization

string (ExternalGroupId) [ 3 .. 64 ] characters

The ID of a group managed by the external identity provider

Responses
200

Successfully updated

put/api/admin/orgs/{org}/adminGroupId
Request samples