List Users
API code: LIST_USERS
Pre-authorized role(s): TENANT_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS
Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/core/tenants/{tenantId}/users
COPY
Path Parameters
string
tenantId
Required
The full tenant ID or tenant name. It must be URL encoded.
Query Parameters
boolean
include-usage
Optional
Indicating whether to return usage for the tenant item of the collection.
integer
offset
Optional
The start index of items to return for the current page.
integer
limit
Optional
The max count of items to return for the current page.
string
order
Optional
The sort spec of the collection. The value is of pattern 'property ASC|DESC'. Only single property order is supported.
Examples:
- lastModifiedDate DESC
- name ASC
string
filter
Optional
filter
Responses
200
OK
Returns PageTenantUser of type(s) application/json
{
"items": [
{
"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"
}
],
"pageInfo": {
"offset": 0,
"limit": 0,
"total": 0
}
}
On This Page
User Management Operations
GET
List Available S3 Users
GET
List Users
PATCH
Update S3 User Mappings