Add Users To Custom Group In Organization By Organization ID And Group ID
DescriptionAdds users to custom group within organization.
Note: Users can only be added to custom groups.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Unique identifier of the group.
Request Body
{
"usernamesToAdd": [
"string"
]
}
List of user names to be added to custom group.
Invited By, specify the actual user who is inviting.
Publish email notification to group members.
Authentication
Response
Response BodyResponse Body
200 OK
{
"failed": [
"string"
],
"succeeded": [
"string"
]
}
The entities for which the operation failed.
The entities for which the operation is successful.
Errors
Group not part of the organization | Adding users to enterprise groups is not allowed
The user is not authorized to use the API
Adding users to shared group is not allowed | org_admin is not allowed to add users to custom group with org_admin or org_owner roles already assigned
Organization with this identifier is not found. | Group with this identifier is not found.
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_owner,org_admin
x-slo-tier: TIER2
