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

Get Logged In User

Description

Retrieves information about the logged user account.

Request

Request

URL

URL


get
https://{api_host}/v1/loggedinuser
Copy

Query Parameters

Query Parameters

boolean
expandUser Optional

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 LoggedInUser of type application/json
{
	"accessToken": "...",
	"accessible": true,
	"address": "...",
	"city": "...",
	"company": "...",
	"country": "...",
	"createTimestamp": 12345,
	"createdByUserId": "...",
	"domain": "...",
	"email": "...",
	"emailVerified": "...",
	"eulaInfo": "...",
	"federated": true,
	"firstName": "...",
	"id": "...",
	"idToken": "...",
	"idpId": "...",
	"internalId": "...",
	"isFederated": true,
	"isNewUIPreferred": true,
	"lastName": "...",
	"linkedUser": {
		"accessible": true,
		"address": "...",
		"city": "...",
		"company": "...",
		"country": "...",
		"createTimestamp": 12345,
		"createdByUserId": "...",
		"domain": "...",
		"email": "...",
		"emailVerified": "...",
		"eulaInfo": "...",
		"firstName": "...",
		"id": "...",
		"idpId": "...",
		"internalId": "...",
		"lastName": "...",
		"password": "...",
		"state": "...",
		"tradeId": "...",
		"updateTimestamp": 12345,
		"updatedByUserId": "...",
		"username": "...",
		"website": "...",
		"workPhone": "...",
		"zipcode": "..."
	},
	"org": {
		"additionalMasterOrgIds": [
			"...",
			"..."
		],
		"addressLine1": "...",
		"addressLine2": "...",
		"adminUserEmail": "...",
		"adminUserName": "...",
		"aggregateContractIds": [
			"...",
			"..."
		],
		"alternatePrimaryContact": {
			"email": "...",
			"username": "..."
		},
		"childOrgIds": [
			"...",
			"..."
		],
		"city": "...",
		"companyName": "...",
		"configStatus": {
			"configResults": [
				{},
				{}
			],
			"configState": "WARNING",
			"createTimestamp": 12345,
			"updateTimestamp": 12345
		},
		"country": "...",
		"createTimestamp": 12345,
		"createdByUserId": "...",
		"description": "...",
		"displayName": "...",
		"domain": "...",
		"id": "...",
		"isFederated": true,
		"metaData": {
			"property1": "...",
			"property2": "..."
		},
		"name": "...",
		"natures": [
			"PARTNER",
			"OPS_STOP"
		],
		"optOut": true,
		"orgType": "PROVIDER",
		"parentOrgId": "...",
		"partnerTypes": [
			"RESELLER",
			"DIRECT_RESELLER"
		],
		"primaryContact": {
			"email": "...",
			"username": "..."
		},
		"providerStatus": "TRIAL",
		"providerType": "STANDARD",
		"realm": "CPHUB",
		"seller": "VMWARE",
		"spPrmId": "...",
		"state": "...",
		"status": "DISABLED",
		"tag": "...",
		"tenantType": "DEFAULT",
		"updateTimestamp": 12345,
		"updatedByUserId": "...",
		"zip": "..."
	},
	"orgContext": "...",
	"password": "...",
	"permissions": [
		"...",
		"..."
	],
	"roles": [
		"...",
		"..."
	],
	"showOptionForUISwitch": true,
	"state": "...",
	"tradeId": "...",
	"updateTimestamp": 12345,
	"updatedByUserId": "...",
	"userLevel": "OPERATOR",
	"username": "...",
	"vuiAccessToken": "...",
	"website": "...",
	"workPhone": "...",
	"zipcode": "..."
}
string
accessToken Optional

The value of the access token


array of string
cspRoles Optional

The list of CSP roles assigned to user


string
idToken Optional

The ID Token is a signed JWT token returned from the authorization server and contains the user profile information, including the domain of the identity provider. This domain is used to obtain the identity provider URL. This token is used for optimization so the application can know the identity of the user, without having to make any additional network requests.


boolean
isNewUIPreferred Optional

Indicates if isNewUIPreferred true or not


Org
org Optional

Defines the properties of Organization.


orgContextType Optional

Defines the organization context which can be CSP ,MSP or NO_ORG.

Possible values are: MSPCSPNO_ORG


array of string
permissions Optional

The list of permissions


string
roleVersion Optional

The roles version of the organization


array of string
roles Optional

The list of roles assigned to user


boolean
showOptionForUISwitch Optional

Indicates if showOptionForUISwitch true or not


array of string
userInvitationOrgs Optional

userSource Optional

The source of the user.

Possible values are: PARTNER_CONNECTREGULAR


string
vuiAccessToken Optional

The value of the VUI access token

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/v1/loggedinuser


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

Was this page helpful?