[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Assign Groups On Organization
DescriptionAssigns organization and service roles to a specified enterprise group within an organization.
Request
URLURL
https://console.navigator.vmware.com/cphub/api/auth/v1/federation/orgs/{orgId}/groups
Path Parameters
Path Parameters
string
orgId
Required
- Organization selected for which the Group roles will be assigned
Request Body
Request Body
{
"failures": {
"property1": {},
"property2": {}
},
"ids": [
"...",
"..."
],
"notifyUsersInGroups": true,
"orgRoleBindingOrgs": [
"...",
"..."
],
"orgRoleItems": {
"roleNamesToAdd": [
"...",
"..."
],
"roleNamesToRemove": [
"...",
"..."
]
},
"serviceRolesItems": {
"serviceRolesItems": [
{
"roleNamesToAdd": [
"...",
"..."
],
"roleNamesToRemove": [
"...",
"..."
],
"rolesToAdd": [
{},
{}
],
"rolesToRemove": [
{},
{}
],
"serviceId": "...",
"serviceType": "external"
},
{
"roleNamesToAdd": [
"...",
"..."
],
"roleNamesToRemove": [
"...",
"..."
],
"rolesToAdd": [
{},
{}
],
"rolesToRemove": [
{},
{}
],
"serviceId": "...",
"serviceType": "external"
}
]
}
}
failures
Optional
Set of error details for each group whose roles failed to be updated.
array of
string
ids
Optional
IDs of the groups to whom the roles will be assigned.
boolean
notifyUsersInGroups
Optional
Publish email notification to group members.
array of
string
orgRoleBindingOrgs
Optional
List of the organization role bindings orgs.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created
Returns
AssignGroupsToOrgAuthRequest
of type application/json
{
"notifyUsersInGroups": true,
"organizationRoles": {
"rolesToAdd": [
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"rolesToRemove": [
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
]
},
"serviceRoles": [
{
"rolesToAdd": [
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"rolesToRemove": [
{
"membershipType": "DIRECT",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"serviceDefinitionId": "..."
},
{
"rolesToAdd": [
{
"membershipType": "DIRECT",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"rolesToRemove": [
{
"membershipType": "DIRECT",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "DIRECT",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"serviceDefinitionId": "..."
}
]
}
failures
Optional
Set of error details for each group whose roles failed to be updated.
array of
string
ids
Optional
IDs of the groups to whom the roles will be assigned.
boolean
notifyUsersInGroups
Optional
Publish email notification to group members.
array of
string
orgRoleBindingOrgs
Optional
List of the organization role bindings orgs.
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"failures":{"property1":{},"property2":{}},"ids":["...","..."],"notifyUsersInGroups":true,"orgRoleBindingOrgs":["...","..."],"orgRoleItems":{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."]},"serviceRolesItems":{"serviceRolesItems":[{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"rolesToAdd":[{},{}],"rolesToRemove":[{},{}],"serviceId":"...","serviceType":"external"},{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"rolesToAdd":[{},{}],"rolesToRemove":[{},{}],"serviceId":"...","serviceType":"external"}]}}' https://console.navigator.vmware.com/cphub/api/auth/v1/federation/orgs/{orgId}/groups
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
