[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Add Users

Description

Add list of users

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/users
Copy

Request Body

Request Body

array of User of type(s) application/json Required

User data collection

{
    "type": "One among: USER, GROUP, SERVICE"
}
string
type Required

The type of the user


string
name Required

The name of the user


role Required

The role of the user


string
creationTimestamp Optional

The timestamp at which the user was created


string
domain Optional

The domain of the user


string
id Optional

The ID of the user


string
apiKey Optional

The API key of the user

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns PageOfUser of type(s) application/json
{
	"elements": [
		{
			"apiKey": "string",
			"creationTimestamp": "string",
			"domain": "string",
			"id": "string",
			"name": "string",
			"role": {
				"id": "string"
			},
			"type": "One among: USER, GROUP, SERVICE"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
array of User
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information


201 Created Response Body>

Response Body

201 Created

Returns PageOfUser of type(s) application/json
{
	"elements": [
		{
			"apiKey": "string",
			"creationTimestamp": "string",
			"domain": "string",
			"id": "string",
			"name": "string",
			"role": {
				"id": "string"
			},
			"type": "One among: USER, GROUP, SERVICE"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
array of User
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information

Errors

Errors

ErrorResponse
400

Bad request


ErrorResponse
401

Unauthorized Request


ErrorResponse
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '[{"type":"One among: USER, GROUP, SERVICE"}]' https://sfo-vcf01.rainpole.io/v1/users


[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?