Create User Group
Create a user group in the caller’s org. A group holds permissions through the regular permission assignment endpoint, and its members hold those permissions in addition to their own.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)❌ Personal Access Token not allowed
✅ Service Account
Required Permissions
Auth:UserGroups:Create: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Body
Response
Success
User group id.
1 - 64^ug-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"ug-139tf-f58l8-lsbt6dp47lfsdvgh"
Name of the group.
Number of members.
x >= 0Organization id.
1 - 64^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"or-30tnh-itmjs-s235s5ontr3r23h2"
Tenant id.
1 - 64^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"acct-24hka-dhili-9hgvdlvr1ohpibp4"
Description of the group.