[{"label":"Latest (v1.0)","version":"latest"}]
csp
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 Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
string
groupId
Required
Unique identifier of the group.
Parameter Serialization Style:
simple Explode:false
Request Body
Request Body
AddUsersToCustomGroupRequest
of mimetype application/json
Required
{
"usernamesToAdd": [
"string"
]
}
array of
string
usernamesToAdd
Required
List of user names to be added to custom group.
string
invitedBy
Optional
Invited By, specify the actual user who is inviting.
boolean
notifyUsers
Optional
Publish email notification to group members.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
PartialSuccessResponseString
of type application/json
{
"failed": [
"string"
],
"succeeded": [
"string"
]
}
array of
string
failed
Optional
The entities for which the operation failed.
array of
string
succeeded
Optional
The entities for which the operation is successful.
Errors
400
Group not part of the organization | Adding users to enterprise groups is not allowed
404
Organization with this identifier is not found. | Group with this identifier is not found.
Code Samples
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"invitedBy":"string","notifyUsers":false,"usernamesToAdd":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/users
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
