[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Add Users V1
DescriptionAdd users to V1 organization
Request
URLURL
https://console.navigator.vmware.com/cphub/api/auth/v1/orgs/{orgId}/add-users
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
string
context
Optional
context can be OPERATOR, PROVIDER or TENANT.
Request Body
Request Body
{
"orgRoleBindingOrgs": [
"string"
],
"orgRolesToAdd": [
"string"
],
"serviceRolesItems": [
{
"roleNamesToAdd": [
"string"
],
"rolesToAdd": {
"name": "string",
"resource": "string"
},
"serviceId": "string"
}
],
"users": [
{
"idpId": "string",
"username": "string"
}
]
}
array of
string
orgRoleBindingOrgs
Optional
List of the organization role bindings orgs.
array of
string
orgRolesToAdd
Optional
The organization roles to add.
Authentication
This operation uses the following authentication methods.
Response
207 Response Body>
Response
202 Accepted Response Body>Response Body
202 Accepted
Returns
AddUserGenericResponseV1
of type application/json
{
"addedUsers": {
"details": "string",
"error": "string",
"errorList": {
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
},
"failedUsers": [
"string"
],
"majorErrorCode": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
],
"refLink": {
"key": "string"
},
"status": "SUCCESS",
"users": [
"string"
]
},
"errorList": [
{
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
}
],
"invitedUsers": {
"details": "string",
"error": "string",
"errorList": {
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
},
"failedUsers": [
"string"
],
"majorErrorCode": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
],
"refLink": {
"key": "string"
},
"status": "SUCCESS",
"users": [
"string"
]
},
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
}
string
majorErrorCode
Optional
The Major error code related to the operation.
string
message
Optional
The message related to the operation.
string
minorErrorCode
Optional
The Minor error code related to the operation.
array of
string
parameterList
Optional
The Parameter list related to the operation.
207 Response Body>
Response Body
207
Returns
AddUserGenericResponseV1
of type application/json
{
"addedUsers": {
"details": "string",
"error": "string",
"errorList": {
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
},
"failedUsers": [
"string"
],
"majorErrorCode": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
],
"refLink": {
"key": "string"
},
"status": "SUCCESS",
"users": [
"string"
]
},
"errorList": [
{
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
}
],
"invitedUsers": {
"details": "string",
"error": "string",
"errorList": {
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
},
"failedUsers": [
"string"
],
"majorErrorCode": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
],
"refLink": {
"key": "string"
},
"status": "SUCCESS",
"users": [
"string"
]
},
"majorErrorCode": "string",
"message": "string",
"minorErrorCode": "string",
"parameterList": [
"string"
]
}
string
majorErrorCode
Optional
The Major error code related to the operation.
string
message
Optional
The message related to the operation.
string
minorErrorCode
Optional
The Minor error code related to the operation.
array of
string
parameterList
Optional
The Parameter list related to the operation.
Errors
400
Bad Request - The request is either incomplete or incorrect
401
Unauthorized - The user is not authorized to use the API
500
Internal Server Error - An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"orgRoleBindingOrgs":["string"],"orgRolesToAdd":["string"],"serviceRolesItems":[{"roleNamesToAdd":["string"],"rolesToAdd":{"name":"string","resource":"string"},"serviceId":"string"}],"users":[{"idpId":"string","username":"string"}]}' https://console.navigator.vmware.com/cphub/api/auth/v1/orgs/{orgId}/add-users
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
On This Page
Service Organization Operations
post
post
delete
get
get
delete
