Update an account.

  • Published on Jul 30, 2024
  • 1 minute(s) read
Prev Next
Patch
/v1/accounts/{account-id}

Update the properties of an account. Only certain properties may be changed with this API.

Security
API Key
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Path parameters
account-id
string (uuid) Required

UUID of an Account.

Body parameters

Request to update an account.

Expand All
object
name
string
custom_logo
string (binary)
add_auth_configs
Array of object (AuthenticationConfig)
object
password
object (AuthConfigPassword)

Configuration for password-based authentication.

require_2fa
boolean Required
administrators_only
boolean Required
oauth
object (AuthConfigOauth)
idp_name
string Required
idp_icon_url
string Required
idp_authorization_endpoint
string Required
idp_token_endpoint
string Required
idp_requires_basic_auth
boolean Required
idp_userinfo_endpoint
string
tls
object (TlsConfig) Required
disabled
object
opportunistic
object
required
object (TlsConfigRequired)
validate_hostname
boolean Required
client_key
string (binary)
client_cert
string (binary)
ca
object (CaConfig) Required
ca_set
string
Valid values[ "GLOBAL_ROOTS" ]
pinned
Array of string
string (binary)
client_id
string Required
client_secret
string Required
cluster_auth_ref
object (AuthConfigRef)
target_id
string Required
mod_auth_configs
object
property*
object (AuthenticationConfig) additionalProperties
password
object (AuthConfigPassword)

Configuration for password-based authentication.

require_2fa
boolean Required
administrators_only
boolean Required
oauth
object (AuthConfigOauth)
idp_name
string Required
idp_icon_url
string Required
idp_authorization_endpoint
string Required
idp_token_endpoint
string Required
idp_requires_basic_auth
boolean Required
idp_userinfo_endpoint
string
tls
object (TlsConfig) Required
disabled
object
opportunistic
object
required
object (TlsConfigRequired)
validate_hostname
boolean Required
client_key
string (binary)
client_cert
string (binary)
ca
object (CaConfig) Required
ca_set
string
Valid values[ "GLOBAL_ROOTS" ]
pinned
Array of string
string (binary)
client_id
string Required
client_secret
string Required
cluster_auth_ref
object (AuthConfigRef)
target_id
string Required
del_auth_configs
Array of string
string (uuid)
enabled
boolean
default_group_id
string (uuid)
marketplace_group_id
string (uuid)
account_status
string
Valid values[ "Active", "Deactivated" ]
Responses
200

Updated account.

Expand All
object
name
string

Name of the account. Account names must be unique within a CCM instance.

acct_id
string (uuid)

Account ID uniquely identifying this account.

created_at
integer (int64)

When this account was created.

roles
Array of string (AccessRoles)

Role of the current user in a particular account.

string

Roles of a user.

Valid values[ "READER", "WRITER", "MANAGER" ]
custom_logo
string (binary)

Logo of the particular account. Max size 128Kb, .jpg, .png, .svg file formats only.

status
string

Status of an Account for a user.

Valid values[ "ACTIVE", "PENDING", "DISABLED" ]
auth_configs
object
property*
object (AuthenticationConfig) additionalProperties
password
object (AuthConfigPassword)

Configuration for password-based authentication.

require_2fa
boolean
administrators_only
boolean
oauth
object (AuthConfigOauth)
idp_name
string
idp_icon_url
string
idp_authorization_endpoint
string
idp_token_endpoint
string
idp_requires_basic_auth
boolean
idp_userinfo_endpoint
string
tls
object (TlsConfig)
disabled
object
opportunistic
object
required
object (TlsConfigRequired)
validate_hostname
boolean
client_key
string (binary)
client_cert
string (binary)
ca
object (CaConfig)
ca_set
string
Valid values[ "GLOBAL_ROOTS" ]
pinned
Array of string
string (binary)
client_id
string
client_secret
string
cluster_auth_ref
object (AuthConfigRef)
target_id
string
node_enrollment
object (NodeEnrollment)
attestation_enforcement_disabled_insecure
boolean
totals
object (ObjectCounts)
datasets
integer
Minimum0
final_workflows
integer
Minimum0
nodes
integer
Minimum0
component
string

Get the account type.

Valid values[ "DEFAULT", "CONFIDENTIAL_AI" ]
default_group_id
string (uuid)

Default group_id in an account.

marketplace_group_id
string (uuid)

Marketplace group_id for the account

account_status
string
Valid values[ "Active", "Deactivated" ]