[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Add Users

Description

Adds new users to an organization and assigns service and organization roles to their accounts. If a user has previously set up VMware ID with their email, they are immediately added to your organization. If a user does not have VMware ID set up, they receive an invitation to create a VMware ID and join your organization.

Request

Request

URL

URL


post
https://{api_host}/v2/orgs/{orgId}/add-users
Copy

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

AddUserRequest of mimetype application/json Optional
{
	"orgRoleBindingOrgs": [
		"string"
	],
	"orgRolesToAdd": [
		"string"
	],
	"serviceRolesItems": [
		{
			"roleNamesToAdd": [
				"string"
			],
			"rolesToAdd": [
				{
					"name": "string",
					"resource": "string"
				}
			],
			"serviceId": "string"
		}
	],
	"users": [
		{
			"idpId": "string",
			"username": "string"
		}
	]
}
array of string
orgRoleBindingOrgs Optional

The organization role binding orgs


array of string
orgRolesToAdd Optional

The organization roles roles to add


serviceRolesItems Optional

The list of service role objects


array of ExtendedUsername
users Optional

The list of users

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted Response Body>

Response Body

202 Accepted

Returns AddUserGenericResponse of type application/json
{
	"failed": {
		"onAdd": {
			"key": "string"
		},
		"onInvite": {
			"key": "string"
		}
	},
	"succeeded": {
		"added": [
			"string"
		],
		"invited": {
			"key": "string"
		}
	}
}
failed Optional

Defines the properties for Add and Invited users which failed.


succeeded Optional

Details of Added and Invited users which succeeded.


207 Response Body>

Response Body

207

Returns AddUserGenericResponse of type application/json
{
	"failed": {
		"onAdd": {
			"key": "string"
		},
		"onInvite": {
			"key": "string"
		}
	},
	"succeeded": {
		"added": [
			"string"
		],
		"invited": {
			"key": "string"
		}
	}
}
failed Optional

Defines the properties for Add and Invited users which failed.


succeeded Optional

Details of Added and Invited users which succeeded.

Errors

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

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://{api_host}/v2/orgs/{orgId}/add-users
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body


Feedback

Was this page helpful?