Get registry auth

Returns the currently configured auth for a registry together with the oauth2 scopes offered by its current well-known advertisement. The advertisement is fetched live; scopes are never cached.

GET /registries/{id}/auth

Get registry auth

cURL

curl --request GET \
  --url http://localhost:9371/registries/{id}/auth

200

{
  "authType": "apiKey",
  "tokenEndpoint": "<string>",
  "headerName": "<string>",
  "tokenExpiresAt": 123,
  "availableScopes": [
    {
      "id": "<string>",
      "description": "<string>"
    }
  ],
  "configuredScopes": [
    "<string>"
  ]
}

Path Parameters

id · string · required

Registry slug identifying the registry.

Minimum string length: 1

Response

200

application/json

The registry auth configuration.

Current auth configuration for a registry and the oauth2 scopes its advertisement offers.

authType · enum<string> | null · required

Available options: apiKey, oauth2, null

tokenEndpoint · string | null · required

headerName · string | null · required

tokenExpiresAt · number | null · required

availableScopes · object[] · required

Scopes advertised by the registry's current well-known document when it advertises oauth2 auth, regardless of whether auth is configured; empty otherwise.

Show child attributes

configuredScopes · string[] · required

Scopes currently configured for the registry.