Get Registry Credentials

GET

/registry/v1/workspaces/{workspace}/engines/{engine}/credentials

curl --request GET \
  --url https://example.com/registry/v1/workspaces/example/engines/example/credentials

Issues a short-lived registry credential for the authenticated caller in a workspace, scoped to the caller’s IAM permissions on the given provider.

Parameters

Path Parameters

workspace

required

string

The workspace to issue credentials for.

engine

required

string

The provider to issue credentials on. A specific provider is required.

Responses

200

OK

Media type application/json

A short-lived registry credential, issued for the authenticated principal in one workspace on one provider. The secret (password) is returned exactly once and never stored server-side.

object

registry_url

The registry endpoint the credential authenticates against (docker login target).

stringOutput only

username

The credential username (the backend robot account name).

stringOutput only

password

The credential secret. Returned exactly once at issuance and never persisted.

stringOutput only

expire_time

When the credential expires.

string format: date-time Output only

principal_id

The principal the credential was issued for (derived from the authenticated caller).

stringOutput only

engine

The provider the credential is scoped to.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO

Example

{
  "engine": "ENGINE_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}