Account

Get and manage account information.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

The Account API resource

A user account.

During a SSO-based authentication, GET /account still returns an account API resource, but a synthetic one that's missing some normal fields.

Content type: application/json

NameNullableTypeDescription
idstring in EID format

Primary ID of the account.

created_at✔string of date/time formatted as RFC 3339

Time at which the account was created.

Always present for a real account, but not present for a synthetic account resource returned during SSO-based authentication.

default_team_id✔string in EID format

The account's default team. If null, the account's default team is their personal team (which has the same ID as the account).

emailstring

Email associated with the account.

has_passwordboolean

Indicates that the account has a password set, as opposed to being SSO-only with no usable password. It's possible for an account to have both a password and a federated identity through a provider like Google or Microsoft.

has_ssoboolean

Indicates that the account has a federated identity for single sign-on through an identity provider like Google or Microsoft.

last_seen_at✔string of date/time formatted as RFC 3339

Time at which the account was last seen in either the API of web dashboard.

login_url✔string

A URL for where it's appropriate to redirect the user to relogin. This may be useful for when it's detected that a session has expired, and to reinitiate a login flow, especially for SSO-based logins that may not use the normal login screen.

multi_factor_enabledboolean

Whether the account has at least one activated multi-factor source.

namestring

Full name associated with the account.

notifications_enabledboolean

Whether email and account notifications are globally enabled for the account. Notifications can also be disabled on a per-notification basis with notification settings, but those settings will be ignored if this flag is set to false.

Some notifications related to billing, security, and onboarding cannot be disabled and this flag will have no effect on them.

updated_at✔string of date/time formatted as RFC 3339

Time at which the account was last updated.

Always present for a real account, but not present for a synthetic account resource returned during SSO-based authentication.

first_name✔string

First name associated with the account.

Deprecated Prefer the use of name (containing full name) instead.

has_personal_teamboolean

Indicates whether the account has a personal team, a team which shares the account's ID which is for its exclusive use.

Deprecated All accounts now always get a personal team so this value is always true.

last_name✔string

Last name associated with the account.

Deprecated Prefer the use of name (containing full name) instead.

Example

{
    "created_at": "2021-07-11T01:02:03Z",
    "dashboard_settings": {
        "rows_per_page": null,
        "skip_cluster_onboarding": false
    },
    "default_team_id": null,
    "email": "[email protected]",
    "first_name": "First",
    "has_password": true,
    "has_personal_team": true,
    "has_sso": false,
    "id": "qvcw4hylovgyzbwzp53bmmlhga",
    "last_name": "Last",
    "last_seen_at": "2021-07-11T01:02:03Z",
    "login_url": null,
    "multi_factor_enabled": true,
    "name": "Cheshire Cat",
    "notifications_enabled": true,
    "updated_at": "2021-07-11T01:02:03Z"
}

Get account

Get the currently authenticated account.

GET /account

cURL example

curl -X GET https://api.crunchybridge.com/account
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard Account API resource.

Destroy account

Delete the currently authenticated account. Accounts can only be deleted if no teams for which they're the only admin own any provisioned clusters. If provisioned clusters still exist, users should deprovision them before trying to call this endpoint. If deletion is successful, teams for which the account was the only admin will also be removed.

DELETE /account

cURL example

curl -X DELETE https://api.crunchybridge.com/account
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard Account API resource.