Get User Group
Get a specific user group.
GET
Get User Group
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Auth:UserGroups:Read: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
Path Parameters
User group id.
Required string length:
1 - 64Pattern:
^ug-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Response
200 - application/json
Success
User group id.
Required string length:
1 - 64Pattern:
^ug-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Example:
"ug-139tf-f58l8-lsbt6dp47lfsdvgh"
Name of the group.
Number of members.
Required range:
x >= 0Organization id.
Required string length:
1 - 64Pattern:
^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Example:
"or-30tnh-itmjs-s235s5ontr3r23h2"
Tenant id.
Required string length:
1 - 64Pattern:
^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Example:
"acct-24hka-dhili-9hgvdlvr1ohpibp4"
Description of the group.