package cs3.ocm.invite.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Invite API The Invite API is meant to invite users and groups belonging to other sync'n'share systems, so that collaboration of resources can be enabled. The following APIs match the OCM v1.1 spec for the /invite-accepted endpoint. 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 AcceptInvite (AcceptInviteRequest, AcceptInviteResponse)

  invite_api.proto:72

  Completes an invitation acceptance. MUST return CODE_NOT_FOUND if the token does not exist. MUST return CODE_INVALID_ARGUMENT if the token expired. MUST return CODE_ALREADY_EXISTS if the user already accepted an invite.

• rpc DeleteAcceptedUser (DeleteAcceptedUserRequest, DeleteAcceptedUserResponse)

  invite_api.proto:80

  Delete a previously accepted remote user, that is unfriend that user. MUST return CODE_NOT_FOUND if the user does not exist.

• rpc FindAcceptedUsers (FindAcceptedUsersRequest, FindAcceptedUsersResponse)

  invite_api.proto:77

  Finds users who accepted invite tokens by their attributes.

• rpc ForwardInvite (ForwardInviteRequest, ForwardInviteResponse)

  invite_api.proto:67

  Forwards a received invite to the remote sync'n'share system provider. The remote system SHALL get an `invite-accepted` call as follows: https://cs3org.github.io/OCM-API/docs.html?branch=v1.2.0&repo=OCM-API&user=cs3org#/paths/~1invite-accepted/post MUST return CODE_NOT_FOUND if the token does not exist. MUST return CODE_INVALID_ARGUMENT if the token expired. MUST return CODE_ALREADY_EXISTS if the user already accepted an invite. MUST return CODE_PERMISSION_DENIED if the remote service is not trusted to accept invitations.

• rpc GenerateInviteToken (GenerateInviteTokenRequest, GenerateInviteTokenResponse)

  invite_api.proto:57

  Generates a new token for the user with a validity of 24 hours.

• rpc GetAcceptedUser (GetAcceptedUserRequest, GetAcceptedUserResponse)

  invite_api.proto:75

  Retrieves details about a remote user who has accepted an invite to share. MUST return CODE_NOT_FOUND if the user does not exist.

• rpc ListInviteTokens (ListInviteTokensRequest, ListInviteTokensResponse)

  invite_api.proto:59

  Lists the valid tokens generated by the user.

Used as request type in: gateway.v1beta1.GatewayAPI.AcceptInvite, InviteAPI.AcceptInvite

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional InviteToken invite_token = 2

  REQUIRED. The token to authenticate with.

• optional identity.user.v1beta1.User remote_user = 3

  REQUIRED. The user who accepted the invite.

Used as response type in: gateway.v1beta1.GatewayAPI.AcceptInvite, InviteAPI.AcceptInvite

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.UserId user_id = 3

  REQUIRED. The initiator's user id of the workflow.

• string email = 4

  REQUIRED. The initiator's email of the workflow.

• string display_name = 5

  REQUIRED. The initiator's display name of the workflow.

Used as request type in: gateway.v1beta1.GatewayAPI.DeleteAcceptedUser, InviteAPI.DeleteAcceptedUser

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.UserId remote_user_id = 2

  REQUIRED. The id of the user.

Used as response type in: gateway.v1beta1.GatewayAPI.DeleteAcceptedUser, InviteAPI.DeleteAcceptedUser

• 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.FindAcceptedUsers, InviteAPI.FindAcceptedUsers

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string filter = 2

  REQUIRED. The filter to apply.

Used as response type in: gateway.v1beta1.GatewayAPI.FindAcceptedUsers, InviteAPI.FindAcceptedUsers

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated identity.user.v1beta1.User accepted_users = 3

  REQUIRED. The accepted users matching the specified filter.

Used as request type in: gateway.v1beta1.GatewayAPI.ForwardInvite, InviteAPI.ForwardInvite

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional InviteToken invite_token = 2

  REQUIRED. The token to authenticate with.

• optional provider.v1beta1.ProviderInfo origin_system_provider = 3

  REQUIRED. The details of the sync'n'share system provider of the user who sent the invite.

Used as response type in: gateway.v1beta1.GatewayAPI.ForwardInvite, InviteAPI.ForwardInvite

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.UserId user_id = 3

  REQUIRED. The initiator's user id of the workflow.

• string email = 4

  REQUIRED. The initiator's email of the workflow.

• string display_name = 5

  REQUIRED. The initiator's display name of the workflow.

Used as request type in: gateway.v1beta1.GatewayAPI.GenerateInviteToken, InviteAPI.GenerateInviteToken

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string description = 2

  OPTIONAL. The description of the token.

Used as response type in: gateway.v1beta1.GatewayAPI.GenerateInviteToken, InviteAPI.GenerateInviteToken

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional InviteToken invite_token = 3

  REQUIRED. The generated token.

Used as request type in: gateway.v1beta1.GatewayAPI.GetAcceptedUser, InviteAPI.GetAcceptedUser

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.UserId remote_user_id = 2

  REQUIRED. The id of the user.

Used as response type in: gateway.v1beta1.GatewayAPI.GetAcceptedUser, InviteAPI.GetAcceptedUser

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.User remote_user = 3

  REQUIRED. The user information.

InviteToken is used to invite users and groups from other sync'n'share systems to collaborate on resources.

Used in: AcceptInviteRequest, ForwardInviteRequest, GenerateInviteTokenResponse, ListInviteTokensResponse

• string token = 1

  REQUIRED. Unique ID associated with an InviteToken.

• optional identity.user.v1beta1.UserId user_id = 2

  REQUIRED. The user who created the token.

• optional types.v1beta1.Timestamp expiration = 3

  OPTIONAL. The time when the token will expire.

• string description = 4

  OPTIONAL. User-defined description to be forwarded to the invitees.

Used as request type in: gateway.v1beta1.GatewayAPI.ListInviteTokens, InviteAPI.ListInviteTokens

(message has no fields)

Used as response type in: gateway.v1beta1.GatewayAPI.ListInviteTokens, InviteAPI.ListInviteTokens

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• repeated InviteToken invite_tokens = 2

  REQUIRED. The list of valid tokens.