Get a specific account.

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

Look up an account by account ID. Current user must belong to a particular account.

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.

Query parameters
with_totals
boolean

Whether to return the totals field in the response

Default"False"
Responses
200

Particular account details.

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" ]