Skip to main content

Add User Profile V3

POST 
/v3/user

Adds either a user profile or a service account profile.

The required request body parameters differ, depending on whether you are adding a user account or a service account. Specify whether you're adding a user account or service account through the request parameter type.

The required parameters to add a user account are:

  • email
  • firstName
  • lastName
  • roleIds
  • defaultRoleId
  • timeZone

The required parameters to add a service account are:

  • username
  • accessKeyName
  • accessKeyExpiration (Required only if enableKeyExpiration is true)
  • defaultRoleId
  • timeZone

Request​

Body

required

Model for User Account

    accessKeyExpiration int64

    Access key expiration timestamp in milliseconds

    accessKeyName string

    Access key name

    accessKeysAllowed boolean

    Access keys allowed

    activeRole object

    Model for User Profile Role Detail

    defaultRoleId string

    Default Role ID

    email string

    Email ID

    enableKeyExpiration boolean

    true = Enable access key expiration. Default is false.

    firstName string

    First name. Maximum length is 300 characters.

    lastName string

    Last name. Maximum length is 300 characters.

    roleIds string[]

    Role IDs

    roles object[]

    All Role Info

  • Array [
  • ]
    • 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.

Responses​

successful operation

Schema
    id string

    Access key ID

    secretKey string

    Access key secret

Loading...