package cs3.auth.applications.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Auth Applications API The Auth Applications API is meant to generate and manage authentication tokens with specified scopes to be used in third-party applications on behalf of the user. 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 GenerateAppPassword (GenerateAppPasswordRequest, GenerateAppPasswordResponse)

  applications_api.proto:57

  GenerateAppPassword creates a password with specified scope to be used by third-party applications.

• rpc GetAppPassword (GetAppPasswordRequest, GetAppPasswordResponse)

  applications_api.proto:63

  GetAppPassword retrieves the password information by the combination of username and password.

• rpc InvalidateAppPassword (InvalidateAppPasswordRequest, InvalidateAppPasswordResponse)

  applications_api.proto:61

  InvalidateAppPassword invalidates a generated password.

• rpc ListAppPasswords (ListAppPasswordsRequest, ListAppPasswordsResponse)

  applications_api.proto:59

  ListAppPasswords lists the application passwords created by a user.

AppPassword stores information about secondary passwords generated by users to be used with third-party applications.

Used in: GenerateAppPasswordResponse, GetAppPasswordResponse, ListAppPasswordsResponse

• string password = 1

  REQUIRED. The generated access password.

• map<string, provider.v1beta1.Scope> token_scope = 2

  OPTIONAL. The scope of the token to be issued. This would be a list of resources with corresponding role-based access scope.

• string label = 3

  OPTIONAL. A label to be associated with the password.

• optional identity.user.v1beta1.UserId user = 4

  REQUIRED. The user who created the password.

• optional types.v1beta1.Timestamp expiration = 5

  OPTIONAL. The time when the token will expire.

• optional types.v1beta1.Timestamp ctime = 6

  REQUIRED. The creation time of the password.

• optional types.v1beta1.Timestamp utime = 7

  REQUIRED. The last time the password was used.

Used as request type in: ApplicationsAPI.GenerateAppPassword, gateway.v1beta1.GatewayAPI.GenerateAppPassword

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• map<string, provider.v1beta1.Scope> token_scope = 2

  OPTIONAL. The scope of the token to be issued. This would be a list of resources with corresponding role-based access scope.

• string label = 3

  OPTIONAL. A label to be associated with the password.

• optional types.v1beta1.Timestamp expiration = 4

  OPTIONAL. The time when the token will expire.

Used as response type in: ApplicationsAPI.GenerateAppPassword, gateway.v1beta1.GatewayAPI.GenerateAppPassword

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional AppPassword app_password = 3

  REQUIRED. The generated access password.

Used as request type in: ApplicationsAPI.GetAppPassword, gateway.v1beta1.GatewayAPI.GetAppPassword

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

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

  REQUIRED. The user who created the app password.

• string password = 3

  REQUIRED. The password which has to be retrieved.

Used as response type in: ApplicationsAPI.GetAppPassword, gateway.v1beta1.GatewayAPI.GetAppPassword

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional AppPassword app_password = 3

  REQUIRED. The generated access password.

Used as request type in: ApplicationsAPI.InvalidateAppPassword, gateway.v1beta1.GatewayAPI.InvalidateAppPassword

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string password = 2

  REQUIRED. The password which has to be invalidated.

Used as response type in: ApplicationsAPI.InvalidateAppPassword, gateway.v1beta1.GatewayAPI.InvalidateAppPassword

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as request type in: ApplicationsAPI.ListAppPasswords, gateway.v1beta1.GatewayAPI.ListAppPasswords

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

Used as response type in: ApplicationsAPI.ListAppPasswords, gateway.v1beta1.GatewayAPI.ListAppPasswords

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated AppPassword app_passwords = 3

  REQUIRED. The generated access password.