Skip to content
InternetData

Organization

get/api/v1/iam/org

The organization this credential is scoped to.

There is no way to name a different one. A credential describes exactly one organization, so an identifier in the path could only ever be your own or a refusal.

Authorization

BearerAuthbearer token

Authorization: Bearer <key>, with a key from the console. Keys are default-deny: each operation names the scope it needs, and an existing key does not gain an operation until that scope is added to it.

Scopes: org.read

Responses

200application/json

The organization.

rcrequiredstring
orgrequiredobject
idrequiredstring (uuid)
namestring
createdstring (date-time)
TypeScript type
ts
{
  rc: string;
  org: {
    id: string;
    name?: string;
    created?: string | null;
  };
}
401application/json

No credential was presented, or it is not valid.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}
403application/json

The credential does not hold the scope this endpoint requires. The missing scope is deliberately not named.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}