Package animeshon.credentials.v1alpha1
Index
- Keeper
- OAuth2
- ActAsCredentialsRequest
- ActAsCredentialsResponse
- ActAsCredentialsResponse.Basic
- CreateCredentialsRequest
- CreateCredentialsRequest.Basic
- CreateCredentialsRequest.OAuth2
- Credentials
- DeleteCredentialsRequest
- ExchangeRequest
- ExchangeResponse
- GetCredentialsRequest
- ListCredentialsRequest
- ListCredentialsResponse
- SignInRequest
- SignInResponse
Keeper
| GetCredentials |
|---|
| rpc GetCredentials(GetCredentialsRequest) Credentials |
| ListCredentials |
|---|
| rpc ListCredentials(ListCredentialsRequest) ListCredentialsResponse |
| CreateCredentials |
|---|
| rpc CreateCredentials(CreateCredentialsRequest) Credentials |
| DeleteCredentials |
|---|
| rpc DeleteCredentials(DeleteCredentialsRequest) .google.protobuf.Empty |
| ActAsCredentials |
|---|
| rpc ActAsCredentials(ActAsCredentialsRequest) ActAsCredentialsResponse |
OAuth2
| SignIn |
|---|
| rpc SignIn(SignInRequest) SignInResponse |
| Exchange |
|---|
| rpc Exchange(ExchangeRequest) ExchangeResponse |
ActAsCredentialsRequest
| Field | Description |
|---|---|
| name | string The resorce name of the credentials. |
ActAsCredentialsResponse
| Field | Description |
|---|---|
| access_token | string The access token to be attached in the request headers. Only returned for OAuth 2.0 credentials. |
| basic | ActAsCredentialsResponse.Basic The basic credentials (username and password) to be used to authenticate requests, as different APIs implement authentication in different ways, the plain basic credentials are provided as-is. |
ActAsCredentialsResponse.Basic
| Field | Description |
|---|---|
| username | string |
| password | string |
CreateCredentialsRequest
| Field | Description |
|---|---|
| credentials | Credentials The credentials to create. |
| oneof payload basic | CreateCredentialsRequest.Basic Basic authentication credentials composed by username and password. |
| oneof payload oauth2 | CreateCredentialsRequest.OAuth2 OAuth 2.0 authentication credentials composed by a refresh token. |
CreateCredentialsRequest.Basic
| Field | Description |
|---|---|
| username | string |
| password | string |
CreateCredentialsRequest.OAuth2
| Field | Description |
|---|---|
| principal | string |
| refresh_token | string |
Credentials
Credentials are persistent authentication
| Field | Description |
|---|---|
| name | string The resorce name of the credentials. |
| uid | string The unique and immutable identifier of the credentials. |
| principal | string The principal of the credentialscode, usually the username. |
| active | google.protobuf.BoolValue Whether these credentials are active and can be used to perform requests. |
| authentication_method | Credentials.AuthenticationMethod Which authentication method is used by the credentials. |
| last_activity_time | google.protobuf.Timestamp When the credentials were last used. |
DeleteCredentialsRequest
| Field | Description |
|---|---|
| name | string The name of the credentials to delete. |
ExchangeRequest
| Field | Description |
|---|---|
| name | string The resorce name of the flow. |
| code | string The OAuth 2.0 code returned from the authentication flow. |
| state | string The OAuth 2.0 state returned from the authentication flow. |
ExchangeResponse
| Field | Description |
|---|---|
| credentials | Credentials The credentials created by the authentication flow. |
GetCredentialsRequest
| Field | Description |
|---|---|
| name | string The name of the credentials to retrieve. |
ListCredentialsRequest
| Field | Description |
|---|---|
| parent | string The parent, which owns this collection of credentials. |
| page_size | int32 If unspecified, server will pick an appropriate default. |
| page_token | string The value returned from the previous call. |
| filter | string A filter to be applied to results. |
ListCredentialsResponse
| Field | Description |
|---|---|
| credentials | repeated Credentials The list of credentials. |
| next_page_token | string A token to retrieve next page of results. |
SignInRequest
| Field | Description |
|---|---|
| name | string The resorce name of the flow. |
SignInResponse
| Field | Description |
|---|---|
| authorization_url | string The authorization url that the user should be redirect to for web sign-in. |
Credentials.AuthenticationMethod
| Name | Description |
|---|---|
| AUTHENTICATION_METHOD_UNSPECIFIED | The default value. This value is used if the state is omitted. |
| BASIC | The authentication method used is username/password. |
| OAUTH2 | The authentication method used is OAuth 2.0. |