serviceaccount¶
Contents¶
-
Services
-
Messages
ServiceAccountService¶
Service account service provides APIs to interact with the platform services resource.
CreateServiceAccount¶
rpc CreateServiceAccount(CreateServiceAccountRequest) ServiceAccount
Create a requested service account under a given Tenant (Organization).
GetServiceAccount¶
rpc GetServiceAccount(GetServiceAccountRequest) ServiceAccount
Returns a requested service account.
ListServiceAccount¶
rpc ListServiceAccount(ListServiceAccountRequest) ListServiceAccountResponse
Returns a requested list of service accounts.
UpdateServiceAccount¶
rpc UpdateServiceAccount(UpdateServiceAccountRequest) ServiceAccount
Updates a service account.
RegenerateServiceAccountSecret¶
rpc RegenerateServiceAccountSecret(RegenerateServiceAccountSecretRequest) ServiceAccount
Regenerate access token for a service account.
GetAccessToken¶
rpc GetAccessToken(GetAccessTokenRequest) AccessToken
Get access token for a service account under a specified Tenant (Organization). (-- api-linter: core::0131::http-body=disabled api-linter: core::0131::http-method=disabled aip.dev/not-precedent: We need to do this because reasons API needs input from request body. --)
DeleteServiceAccount¶
rpc DeleteServiceAccount(DeleteServiceAccountRequest) .google.protobuf.Empty
Initiates deletion of a service account.
Messages¶
AccessToken¶
The response contains access token for the service account.
| Field | Type | Description |
|---|---|---|
| token | string | Access token for a service account. |
Config¶
Config clubs attributes represents in detail view for service account.
| Field | Type | Description |
|---|---|---|
| client_id | string | Client id. |
| client_secret | string | Client secret. |
| disabled | bool | If sets to true then service account will be inactive, false by default. |
CreateServiceAccountRequest¶
Attributes required to create a service account record.
| Field | Type | Description |
|---|---|---|
| tenant_id | string | The parent Tenant (Organization) under which the service account will be created (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to support creation of the resource in the Tenant (Organization) context. --) |
| service_account | ServiceAccount | Service account details. |
DeleteServiceAccountRequest¶
Attributes required to process deletion of service account.
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the service account to be deleted. |
GetAccessTokenRequest¶
Request to fetch the access token of a service account.
| Field | Type | Description |
|---|---|---|
| tenant_id | string | ID of the Tenant (Organization) under which the service account was created. |
| client_id | string | Unique identifier generated at the time of service account creation. |
| client_secret | string | Secret key generated at the time of service account creation. |
GetServiceAccountRequest¶
Request to fetch a service account details.
| Field | Type | Description |
|---|---|---|
| tenant_id | string | Tenant (Organization) id to which a service account is associated. |
| id | string | Unique identifier for the service account to be fetched. |
ListServiceAccountRequest¶
Attributes required to list service account records.
| Field | Type | Description |
|---|---|---|
| tenant_id | string | id of Tenant (Organization) on which service account should be listed. If not provided, then list will filtered on account id present in the context. |
| sort | public.portworx.common.v1.Sort | Sorting details using which requested list of service account to be sorted. |
| pagination | public.portworx.common.v1.PageBasedPaginationRequest | Pagination parameters for listing service accounts. |
ListServiceAccountResponse¶
Response of requested list of service accounts.
| Field | Type | Description |
|---|---|---|
| service_accounts | repeated ServiceAccount | Requested list of service accounts. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We really need this field because reasons. --) |
| pagination | public.portworx.common.v1.PageBasedPaginationResponse | Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --) |
RegenerateServiceAccountSecretRequest¶
Attributes required to rotate secrets for a service account.
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the service account. |
ServiceAccount¶
Service account represents a group of attributes using which a service can consume platform apis.
| Field | Type | Description |
|---|---|---|
| meta | public.portworx.common.v1.Meta | Metadata of the service account. |
| config | Config | Configuration details of service account. |
| status | Status | Status of service account. |
Status¶
Status of the service account.
| Field | Type | Description |
|---|---|---|
| secret_generation_count | int32 | Represents how many times the service account secret has been rotated. |
| last_secret_update_time | google.protobuf.Timestamp | When last time the secrets of the service account has been updated. |
UpdateServiceAccountRequest¶
Updated attributes of a service account.
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the service account. |
| service_account | ServiceAccount | Service account to be updated. |