package cs3.auth.registry.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Auth Registry API The Auth Registry API is meant to as registry to obtain information of available auth providers. For example, to use OIDC or Kerberos for authentication. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. The following are global requirements that apply to all methods: Any method MUST return CODE_OK on a succesful operation. Any method MAY return NOT_IMPLEMENTED. Any method MAY return INTERNAL. Any method MAY return UNKNOWN. Any method MAY return UNAUTHENTICATED.

• rpc GetAuthProviders (GetAuthProvidersRequest, GetAuthProvidersResponse)

  registry_api.proto:56

  Returns the auth provider that is reponsible for the given resource reference. MUST return CODE_NOT_FOUND if the reference does not exist.

  message GetAuthProvidersRequest

  registry_api.proto:61

  • optional types.v1beta1.Opaque opaque = 1

    OPTIONAL. Opaque information.

  • string type = 2

    REQUIRED. The type of authentication provider.

  message GetAuthProvidersResponse

  registry_api.proto:70

  • optional rpc.v1beta1.Status status = 1

    REQUIRED. The response status.

  • optional types.v1beta1.Opaque opaque = 2

    OPTIONAL. Opaque information.

  • repeated ProviderInfo providers = 3

    REQUIRED. The auth providers handling the requested auth call.

• rpc ListAuthProviders (ListAuthProvidersRequest, ListAuthProvidersResponse)

  registry_api.proto:58

  Returns a list of the available auth providers known by this registry.

  message ListAuthProvidersResponse

  registry_api.proto:89

  • optional rpc.v1beta1.Status status = 1

    REQUIRED. The response status.

  • optional types.v1beta1.Opaque opaque = 2

    OPTIONAL. Opaque information.

  • repeated ProviderInfo providers = 3

    REQUIRED. The list of auth providers this registry knows about.

Used as request type in: RegistryAPI.ListAuthProviders, gateway.v1beta1.GatewayAPI.ListAuthProviders

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

  TODO(labkode): maybe add some filter?

ProviderInfo provides the information about an authentication provider.

Used in: GetAuthProvidersResponse, ListAuthProvidersResponse

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information (containing storage-specific information). For example, additional metadata attached to the resource.

• string provider_type = 2

  REQUIRED. The storage provider id that will become part of the resource id. For example, if the provider_id is "home", resources obtained from this storage provider will have a resource id like "home:1234".

• string address = 4

  REQUIRED. The address where the storage provider can be reached. For example, tcp://localhost:1099.

• string description = 5

  OPTIONAL. Information to describe the functionalities offered by the storage provider. Meant to be read by humans.