List Users V3

GET 
/v3/user

Lists all users and service accounts for your tenant.

Empty Fields:

• accessKeyExpiration
• accessKeyName
• activeRole

To retrieve these fields, use the GET - /access_keys endpoint

Responses

200

successful operation

application/json

Schema

Schema

• Array [
accessKeyExpiration int64

Access key expiration timestamp in milliseconds

accessKeyName string

Access key name

accessKeysAllowed boolean

Access keys allowed

accessKeysCount int32

Access key count

activeRole object

Model for User Profile Role Detail

id string

User Role ID

name string

User Role Name

onlyAllowCIAccess boolean

true = Allow only CI Access for Build and Deploy security roles

onlyAllowComputeAccess boolean

true = Allow only Compute Access for reduced system admin roles

onlyAllowReadAccess boolean

true = Allow only Read Access for

type string

User Role Type (Default or Custom Permission Group Name).

defaultRoleId string

Default Role ID

displayName string

Display name

email string

Email ID

enableKeyExpiration boolean

true = Enable access key expiration. Default is false.

enabled boolean

Enabled

firstName string

First name. Maximum length is 300 characters.

lastLoginTs int64

Last login time

lastModifiedBy string

Last modified by

lastModifiedTs int64

Time profile was last updated

lastName string

Last name. Maximum length is 300 characters.

roleIds string[]

Role IDs

roles object[]
All Role Info
Array [
id string
User Role ID
name string
User Role Name
onlyAllowCIAccess boolean
true = Allow only CI Access for Build and Deploy security roles
onlyAllowComputeAccess boolean
true = Allow only Compute Access for reduced system admin roles
onlyAllowReadAccess boolean
true = Allow only Read Access for
type string
User Role Type (Default or Custom Permission Group Name).
]
timeZone string

Time zone (e.g. America/Los_Angeles)

type string

Possible values: [USER_ACCOUNT, SERVICE_ACCOUNT]

User type. Default is USER_ACCOUNT.

username string

User or service account name. Maximum length is 300 characters.

• ]

Example (from schema)

[
  {
    "accessKeyExpiration": 0,
    "accessKeyName": "string",
    "accessKeysAllowed": true,
    "accessKeysCount": 0,
    "activeRole": {
      "id": "string",
      "name": "string",
      "onlyAllowCIAccess": true,
      "onlyAllowComputeAccess": true,
      "onlyAllowReadAccess": true,
      "type": "string"
    },
    "defaultRoleId": "string",
    "displayName": "string",
    "email": "string",
    "enableKeyExpiration": true,
    "enabled": true,
    "firstName": "string",
    "lastLoginTs": 0,
    "lastModifiedBy": "string",
    "lastModifiedTs": 0,
    "lastName": "string",
    "roleIds": [
      "string"
    ],
    "roles": [
      {
        "id": "string",
        "name": "string",
        "onlyAllowCIAccess": true,
        "onlyAllowComputeAccess": true,
        "onlyAllowReadAccess": true,
        "type": "string"
      }
    ],
    "timeZone": "string",
    "type": "USER_ACCOUNT",
    "username": "string"
  }
]

Loading...