[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Update Group Roles On Organization
DescriptionUpdates the organization and service roles of a specified enterprise group within an organization.
Request
URLURL
https://console.navigator.vmware.com/cphub/api/auth/v1/federation/orgs/{orgId}/groups/{groupId}/roles
Path Parameters
Path Parameters
string
groupId
Required
- Group selected for which the roles will be updated
string
orgId
Required
- Organization selected for which the Group roles will be Updated
Request Body
Request Body
UpdateGroupRolesAuthRequest
of mimetype application/json
Optional
- Payload contains the roles to be added and deleted from the group
{
"addOrgBindings": [
"...",
"..."
],
"notifyUsersInGroups": true,
"orgRoleItems": {
"roleNamesToAdd": [
"...",
"..."
],
"roleNamesToRemove": [
"...",
"..."
]
},
"removeOrgBindings": [
"...",
"..."
],
"serviceRolesItems": {
"serviceRolesItems": [
{
"roleNamesToAdd": [
"...",
"..."
],
"roleNamesToRemove": [
"...",
"..."
],
"rolesToAdd": [
{},
{}
],
"rolesToRemove": [
{},
{}
],
"serviceId": "...",
"serviceType": "internal"
},
{
"roleNamesToAdd": [
"...",
"..."
],
"roleNamesToRemove": [
"...",
"..."
],
"rolesToAdd": [
{},
{}
],
"rolesToRemove": [
{},
{}
],
"serviceId": "...",
"serviceType": "internal"
}
]
},
"updateRoles": [
"...",
"..."
]
}
array of
string
addOrgBindings
Optional
The Organization bindings to be added.
boolean
notifyUsersInGroups
Optional
Publish email notification to group members.
array of
string
removeOrgBindings
Optional
The Organization bindings to be removed.
array of
string
updateRoles
Optional
The Roles to be updated.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
204 No Content
Returns
UpdateGroupRolesAuthRequest
of type application/json
Request has succeeded
{
"notifyUsersInGroups": true,
"organizationRoles": {
"rolesToAdd": [
{
"membershipType": "DIRECT",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"rolesToRemove": [
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "DIRECT",
"name": "...",
"resource": "...",
"roleName": "..."
}
]
},
"serviceRoles": [
{
"rolesToAdd": [
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"rolesToRemove": [
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"serviceDefinitionId": "..."
},
{
"rolesToAdd": [
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"rolesToRemove": [
{
"membershipType": "GROUP",
"name": "...",
"resource": "...",
"roleName": "..."
},
{
"membershipType": "NESTED",
"name": "...",
"resource": "...",
"roleName": "..."
}
],
"serviceDefinitionId": "..."
}
]
}
array of
string
addOrgBindings
Optional
The Organization bindings to be added.
boolean
notifyUsersInGroups
Optional
Publish email notification to group members.
array of
string
removeOrgBindings
Optional
The Organization bindings to be removed.
array of
string
updateRoles
Optional
The Roles to be updated.
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{"addOrgBindings":["...","..."],"notifyUsersInGroups":true,"orgRoleItems":{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."]},"removeOrgBindings":["...","..."],"serviceRolesItems":{"serviceRolesItems":[{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"rolesToAdd":[{},{}],"rolesToRemove":[{},{}],"serviceId":"...","serviceType":"internal"},{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"rolesToAdd":[{},{}],"rolesToRemove":[{},{}],"serviceId":"...","serviceType":"internal"}]},"updateRoles":["...","..."]}' https://console.navigator.vmware.com/cphub/api/auth/v1/federation/orgs/{orgId}/groups/{groupId}/roles
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
