package cs3.identity.tenant.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Provides an API for managing users.

• rpc GetTenant (GetTenantRequest, GetTenantResponse)

  tenant_api.proto:55

  Gets the information about a Tenant by the tenant id.

• rpc GetTenantByClaim (GetTenantByClaimRequest, GetTenantByClaimResponse)

  tenant_api.proto:57

  Gets the information about a Tenant based on a specified claim.

Used as request type in: gateway.v1beta1.GatewayAPI.GetTenantByClaim, TenantAPI.GetTenantByClaim

• string claim = 1

  REQUIRED. The claim on the basis of which users will be filtered.

• string value = 2

  REQUIRED. The value of the claim to find the specific user.

Used as response type in: gateway.v1beta1.GatewayAPI.GetTenantByClaim, TenantAPI.GetTenantByClaim

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional Tenant tenant = 2

  REQUIRED. The tenant information.

Used as request type in: gateway.v1beta1.GatewayAPI.GetTenant, TenantAPI.GetTenant

• string tenant_id = 1

  REQUIRED. The id of the tenant.

Used as response type in: gateway.v1beta1.GatewayAPI.GetTenant, TenantAPI.GetTenant

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional Tenant tenant = 2

  REQUIRED. The tenant information.

A Tenant represents an isolated organization. Users can be member of exactly one tenant. Members of different tenants are unable to access each others resources.

Used in: GetTenantByClaimResponse, GetTenantResponse

• string id = 1

  REQUIRED. The unique identifier of the tenant. This is a UUID

• string name = 2

  OPTIONAL The name of the Tenant

• string external_id = 3

  OPTIONAL An external identifier to able to lookup Tenants by externally managed IDs