package cs3.ocm.provider.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

OCM Auth Provider API The Auth Provider API is meant to authenticate a sync'n'share provider regsistered in the mesh. 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 GetInfoByDomain (GetInfoByDomainRequest, GetInfoByDomainResponse)

  provider_api.proto:56

  Get the information of the provider identified by a specific domain. MUST return CODE_NOT_FOUND if the sync'n'share system provider does not exist.

• rpc IsProviderAllowed (IsProviderAllowedRequest, IsProviderAllowedResponse)

  provider_api.proto:53

  Check if a given system provider is registered in the mesh or not. MUST return CODE_UNAUTHENTICATED if the system is not registered

• rpc ListAllProviders (ListAllProvidersRequest, ListAllProvidersResponse)

  provider_api.proto:58

  Get the information of all the providers registered in the mesh.

Used as request type in: gateway.v1beta1.GatewayAPI.GetInfoByDomain, ProviderAPI.GetInfoByDomain

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string domain = 2

  REQUIRED. The domain of the system provider.

Used as response type in: gateway.v1beta1.GatewayAPI.GetInfoByDomain, ProviderAPI.GetInfoByDomain

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional ProviderInfo provider_info = 3

  REQUIRED. The info of the provider

Used as request type in: gateway.v1beta1.GatewayAPI.IsProviderAllowed, ProviderAPI.IsProviderAllowed

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional ProviderInfo provider = 2

  REQUIRED. The provider that we need to check against the list of verified mesh providers.

Used as response type in: gateway.v1beta1.GatewayAPI.IsProviderAllowed, ProviderAPI.IsProviderAllowed

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.ListAllProviders, ProviderAPI.ListAllProviders

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

Used as response type in: gateway.v1beta1.GatewayAPI.ListAllProviders, ProviderAPI.ListAllProviders

• 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 share.

Details of the sync'n'share system provider.

Used in: invite.v1beta1.ForwardInviteRequest, GetInfoByDomainResponse, IsProviderAllowedRequest, ListAllProvidersResponse, sharing.ocm.v1beta1.CreateOCMShareRequest

• string name = 1

  REQUIRED. The name of the provider.

• string full_name = 2

  REQUIRED. The full name of the provider.

• string description = 3

  OPTIONAL. A description of the provider.

• string organization = 4

  OPTIONAL. The organization to which the provider belongs.

• string domain = 5

  REQUIRED. The domain of the sync'n'share provider.

• string homepage = 6

  OPTIONAL. The homepage of the provider.

• string email = 7

  OPTIONAL. The email at which the provider can be reached.

• repeated Service services = 8

  REQUIRED. The list of services provided by the provider.

• map<string, string> properties = 9

  OPTIONAL. Additional properties about the service.

The services offered by sync'n'share system providers.

Used in: ProviderInfo

• string host = 1

  REQUIRED. The URL at which the service is hosted.

• optional ServiceEndpoint endpoint = 2

  REQUIRED. The primary endpoint of the service.

• string api_version = 3

  REQUIRED. The API version of the provided service.

• repeated ServiceEndpoint additional_endpoints = 4

  OPTIONAL. Additional endpoints at which the service is exposed.

The endpoints exposed by particular services.

Used in: Service

• optional ServiceType type = 1

  REQUIRED. The type of service.

• string name = 2

  REQUIRED. The name of the service.

• string path = 3

  REQUIRED. The path at which the service is hosted.

• bool is_monitored = 4

  OPTIONAL. Whether the service is monitored.

• map<string, string> properties = 5

  OPTIONAL. Additional properties about the service.

Identifier for various types of services offered by sync'n'share system providers.

Used in: ServiceEndpoint

• string name = 1

  REQUIRED The name of the service type.

• string description = 2

  REQUIRED The description of the service type.