GET Find organisation og ressourcer · TCGM API v1

GETFind organisation og ressourcer

Henter nøglens organisation, scopes og ressourcer. Ændrer ingen data.

Endpoint

GEThttps://www.tcgm.dk/api/v1/access

Autorisation

Bearer-nøgle. Intet særskilt scope kræves.

Headers

Authorizationstring · påkrævet: Bearer <api-nøgle>. Nøglen oprettes af en owner/admin på organisationens API-side.; header.Authorization (påkrævet)
Gemmes kun i denne sides hukommelse.

Response · 200

Nøglens aktuelle adgang.

Response · 200

Cache-Control: no-store

{
  organization: {
    id: string;
    slug: string;
    name: string;
  };
  scopes: Array<"store:events:create" | "store:events:read" | "store:events:update" | "store:events:delete" | "webshop:orders:read" | "webshop:orders:create" | "webshop:orders:update" | "webshop:orders:queue" | "webshop:orders:complete" | "webshop:events:read">;
  resourceAccess: "all" | "selected";
  resources: Array<{
    id: string;
    slug: string;
    name: string;
    type: "store" | "webshop" | "event";
    scopes: Array<"store:events:create" | "store:events:read" | "store:events:update" | "store:events:delete" | "webshop:orders:read" | "webshop:orders:create" | "webshop:orders:update" | "webshop:orders:queue" | "webshop:orders:complete" | "webshop:events:read">;
  }>;
}

Statuskoder

200: Nøglens aktuelle adgang.
401: Manglende eller ugyldig Bearer-nøgle: invalid_credential.
403: Adgang nægtet: nøgle, scope, ejerskab eller godkendelse er ikke længere gyldig.
503: Lager eller behandling er utilgængelig. Ingen interne fejl eller skemadetaljer udleveres i produktion.
405: HTTP-metoden understøttes ikke.

Headers og fejlfelter

Response · 401

Cache-Control: no-store
WWW-Authenticate: Bearer

{
  error: string;
}

Response · 403, 503

Cache-Control: no-store

{
  error: string;
}

Adfærd og genforsøg

Listen kan være tom. all omfatter nuværende og fremtidige godkendte ressourcer inden for nøglens organisation; selected omfatter kun valgte ressourcer. TCGM-administrationsorganisationen udleveres ikke.

Query-parametre kan ikke vælge en anden organisation eller udvide adgangen.

Cache-Control: no-store { organization: { id: string; slug: string; name: string; }; scopes: Array<"store:events:create" | "store:events:read" | "store:events:update" | "store:events:delete" | "webshop:orders:read" | "webshop:orders:create" | "webshop:orders:update" | "webshop:orders:queue" | "webshop:orders:complete" | "webshop:events:read">; resourceAccess: "all" | "selected"; resources: Array<{ id: string; slug: string; name: string; type: "store" | "webshop" | "event"; scopes: Array<"store:events:create" | "store:events:read" | "store:events:update" | "store:events:delete" | "webshop:orders:read" | "webshop:orders:create" | "webshop:orders:update" | "webshop:orders:queue" | "webshop:orders:complete" | "webshop:events:read">; }>; }