Get User
API code: GET_USER
Pre-authorized role(s): TENANT_USER
| TENANT_ADMIN
Platform(s): AMAZON
| OSIS
| CLOUDIAN
| ECS
Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/core/tenants/{tenantId}/users/{userName}
COPY
Path Parameters
string
tenantId
Required
The full tenant ID or tenant name. It must be URL encoded.
string
userName
Required
The user name.
Responses
200
OK
Returns TenantUser of type(s) application/json
{
"name": "string",
"id": "string",
"fullName": "string",
"role": "string",
"subordinateRoles": [
"string"
],
"active": false,
"tenant": {
"id": "string",
"name": "string",
"solutionOrg": false,
"tenantSetting": {
"poseAsPermission": "string"
},
"siteId": "string",
"regionSiteId": "string",
"source": "string",
"fullName": "string",
"platforms": {
"platforms": {
"name": "string",
"version": "string",
"regions": [
"string"
],
"storageClasses": [
"string"
],
"active": false,
"storageTenantId": "string",
"logoUri": "string",
"defaultMapping": false,
"timeline": {
"id": 0,
"tenantId": "string",
"accountId": "string",
"accountFlow": "string",
"accountStatus": "string",
"accountEmail": "string",
"creationDate": "string",
"lastModifiedDate": "string",
"accountHistories": [
{
"status": "string",
"action": "string",
"date": "string"
}
],
"tenantEnabled": false,
"accountHealth": "string",
"healthMessage": "string",
"cleanBeforeReady": false
}
}
},
"platform": {
"name": "string",
"logUri": "string"
},
"usedBytes": 0,
"objectCount": 0,
"bucketCount": 0,
"lastModifiedDate": "string",
"modifier": "string",
"purgeState": "string",
"deleteRequest": "string",
"errorMessage": "string",
"region": "string",
"storagePolicyLocked": false,
"storagePolicy": "string",
"associatedOrgId": "string",
"autoOnboardForbidden": false,
"autoOnboardConfig": {
"region": "string",
"autoOnboard": false,
"storagePolicyId": "string",
"storagePolicyName": "string",
"storagePolicyLocked": false
},
"active": false
},
"currentRegion": "string",
"site": {
"id": "string",
"name": "string",
"restEndpoint": "string"
},
"usage": {
"scope": "string",
"totalBytes": 0,
"usedBytes": 0,
"availableBytes": 0,
"objectCount": 0,
"bucketCount": 0
},
"userCapabilities": {
"userCapabilities": false
},
"storageTenantId": "string",
"storageUserId": "string",
"existedOnStorage": false,
"policyArns": [
"string"
],
"storageCanonicalId": "string",
"storageUserArn": "string",
"activeRegions": [
{
"name": "string",
"endpoint": "string",
"platform": "string",
"version": "string",
"tenantName": "string",
"tenantId": "string",
"storageTenantId": "string",
"logoUri": "string",
"active": false,
"defaultMapping": false,
"siteId": "string",
"usedBytes": 0,
"objectCount": 0,
"bucketCount": 0,
"storageClasses": [
"string"
],
"lastModifiedDate": "string",
"timeline": {
"id": 0,
"tenantId": "string",
"accountId": "string",
"accountFlow": "string",
"accountStatus": "string",
"accountEmail": "string",
"creationDate": "string",
"lastModifiedDate": "string",
"accountHistories": [
{
"status": "string",
"action": "string",
"date": "string"
}
],
"tenantEnabled": false,
"accountHealth": "string",
"healthMessage": "string",
"cleanBeforeReady": false
},
"poseAsPermission": "string",
"health": "string"
}
],
"mappedS3UserCount": 0,
"poseAsUser": false,
"remote": false,
"sourceTenant": "string"
}
string
name
Optional
name
string
id
Optional
id
string
fullName
Optional
fullName
string
role
Optional
role
Possible values are : PROVIDER_ADMIN, TENANT_ADMIN, TENANT_USER, ANONYMOUS, UNDETERMINED_USER,
array of string
subordinateRoles
Optional
subordinateRoles
Possible values are : VAPP_CONTRIBUTOR, CATALOG_CONTRIBUTOR, KUBERNETES_CONTRIBUTOR,
boolean
active
Optional
active
string
currentRegion
Optional
currentRegion
object
userCapabilities
Optional
userCapabilities
string
storageTenantId
Optional
storageTenantId
string
storageUserId
Optional
storageUserId
boolean
existedOnStorage
Optional
existedOnStorage
array of string
policyArns
Optional
policyArns
string
storageCanonicalId
Optional
storageCanonicalId
string
storageUserArn
Optional
storageUserArn
integer As int32 As int32
mappedS3UserCount
Optional
mappedS3UserCount
boolean
poseAsUser
Optional
poseAsUser
boolean
remote
Optional
remote
string
sourceTenant
Optional
sourceTenant
User Management Operations
POST
Add S3 Credential
GET
Get Canonical User Id
GET
Get Current User
GET
Get S3 Credential
GET
Get S3 User Mappings
GET
Get User
GET
List Kms Keys
GET
List S3 App Credentials
GET
List S3 Credentials
DELETE
Remove S3 Credential
PUT
Rotate S3 Credential
PATCH
Update S3 Credential