CustomDomain Docs
ReferenceAPI referenceProvider accounts

One provider account with its domains

One provider account with its domains: CustomDomain™ API reference in the provider accounts group. Covers parameters, request body, responses and error codes.

GET
/provider-accounts/{id}

A viewer reads it without agent_key.account and agent_key.session_id.

For whoever manages the account (can_manage, and never a viewer), it also carries more_domains: the domains the key lists at the provider that the workspace has not connected, to offer them with POST /provider-accounts/{id}/connect. Listing them is a use of the key, so it is asked of the provider on this read (kept for a minute) and left out for anyone else, for a key an end user's secure sign-in made, and for an account with no usable key. The read changes nothing: a key the provider refuses, or a list that fails, leaves more_domains out and the account as it was.

AuthorizationBearer <token>

Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/provider-accounts/string"
{  "account": {    "needs_you": {      "reason": "refused",      "until": "2019-08-24T14:15:22Z"    },    "health": {      "state": "ok",      "checked_at": "2019-08-24T14:15:22Z",      "failures": 0    },    "made_by": {      "how": "pasted",      "by": "string"    },    "enforced_by": "provider",    "more_domains": [      "string"    ],    "id": "string",    "kind": "api_key",    "provider": "string",    "provider_name": "string",    "label": "string",    "access": "continuous",    "scope": "all",    "domains": [      "string"    ],    "credential_held": true,    "status": "active",    "last_error": "string",    "created_by": "string",    "last_used_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "connections": [      {        "id": "string",        "application_id": "string",        "domain": "string",        "status": "string"      }    ],    "uses": [      "string"    ],    "can_manage": true,    "application_id": "string",    "application_ids": [      "string"    ],    "origin": "browser_agent",    "agent_key": {      "name": "string",      "scopes": [        "string"      ],      "account": "string",      "session_id": "string",      "verified_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "notice": "d30",      "reconnect_reason": "expiring",      "reconnect_sent_at": "2019-08-24T14:15:22Z",      "renewed_at": "2019-08-24T14:15:22Z",      "old_key": "revoke_by_hand",      "revoke_url": "http://example.com",      "rights": [        "transfer"      ]    },    "owner_kind": "workspace",    "end_user_ref": "string",    "account_ref": "string"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}