Describe the calling key

GET

/content/deployment/v1/whoami

const url = 'https://api.ebitex.io/content/deployment/v1/whoami';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/content/deployment/v1/whoami \
  --header 'Authorization: Bearer <token>'

Reports what the deployment key you are calling with is: the organization it belongs to, the promotion edge it is bound to (a source environment and a target), the role it acts as, its own id and name, and its scopes.

A deployment key promotes content along exactly one edge, and nothing else. Call this before acting on a key you did not mint yourself. It works with any valid deployment key whatever its scopes, so a key that can only plan can find out that planning is all it can do.

edge.active is false when the edge has been removed from the organization’s topology. The key still authenticates, and plan and execute answer not_a_promotion_target until the edge is added back.

Key: a delivery key (content.delivery.read).

Authorizations

apiKey

Responses

200

{ "organizationId", "organizationName", "organizationSlug", "keyId", "keyName", "edge": { "source": { "id", "name" }, "target": { "id", "name" }, "active" }, "roleId", "roleName", "allowOverwriteDiverged", "scopes": [ … ] }. scopes is sorted.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

403

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

429

Quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.