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

Get Calling User

Description

Retrieves information about the user account performing the API call.

Request

Request

URL

URL


get
https://console.navigator.vmware.com/cphub/api/auth/v1/users/calling-user
Copy

Query Parameters

Query Parameters

boolean
expandUser Required

Indicates if the response should be expanded with the user profile


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns CallingUser of type application/json
{
	"accessible": false,
	"address": "string",
	"city": "string",
	"company": "string",
	"country": "string",
	"createTimestamp": 0,
	"createdByUserId": "string",
	"domain": "string",
	"email": "string",
	"emailVerified": "string",
	"eulaInfo": "string",
	"firstName": "string",
	"id": "string",
	"idpId": "string",
	"internalId": "string",
	"isFederated": false,
	"lastName": "string",
	"linkedUser": {
		"accessible": false,
		"address": "string",
		"city": "string",
		"company": "string",
		"country": "string",
		"createTimestamp": 0,
		"createdByUserId": "string",
		"domain": "string",
		"email": "string",
		"emailVerified": "string",
		"eulaInfo": "string",
		"firstName": "string",
		"id": "string",
		"idpId": "string",
		"internalId": "string",
		"lastName": "string",
		"password": "string",
		"state": "string",
		"tradeId": "string",
		"updateTimestamp": 0,
		"updatedByUserId": "string",
		"username": "string",
		"website": "string",
		"workPhone": "string",
		"zipcode": "string"
	},
	"orgContext": "string",
	"password": "string",
	"state": "string",
	"tradeId": "string",
	"updateTimestamp": 0,
	"updatedByUserId": "string",
	"userLevel": "OPERATOR",
	"username": "string",
	"website": "string",
	"workPhone": "string",
	"zipcode": "string"
}
boolean
isFederated Optional

Returns true if user is federated


linkedUser Optional

Defines the properties of User Details.


string
orgContext Optional

The context of the organization


userLevel Optional

The type of the organization.

Possible values are: OPERATORPROVIDERTENANT

Errors

Errors

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 https://console.navigator.vmware.com/cphub/api/auth/v1/users/calling-user?expandUser=false


Feedback

Was this page helpful?