Skip to main content
API docs by Redocly

public/portworx/platform/serviceaccount/apiv1/serviceaccount.proto (version not set)

Download OpenAPI specification:Download

ServiceAccountService

Returns a requested list of service accounts.

query Parameters
tenantId
string

id of tenant on which service account should be listed. If not provided, then list will filtered on account id present in the context.

sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

Responses

Response samples

Content type
application/json
{
  • "serviceAccounts": [
    ],
  • "pagination": {
    }
}

Returns a requested service account.

path Parameters
id
required
string

Unique identifier for the service account to be fetched.

query Parameters
tenantId
string

Tenant id to which a service account is associated.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

Initiates deletion of a service account.

path Parameters
id
required
string

Unique identifier for the service account to be deleted.

Responses

Response samples

Content type
application/json
{ }

Updates a service account.

path Parameters
id
required
string

Unique identifier for the service account.

Request Body schema: application/json
required

Service account to be updated.

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Config clubs attributes represents in detail view for service account.

object (serviceaccountv1Status)

Status of the service account.

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": { }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

Regenerate access token for a service account.

path Parameters
id
required
string

Unique identifier for the service account.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

Create a requested service account.

path Parameters
tenantId
required
string

The parent tenant under which the service account will be created

Request Body schema: application/json
required

Service account details.

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Config clubs attributes represents in detail view for service account.

object (serviceaccountv1Status)

Status of the service account.

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": { }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

Get access token for a service account.

path Parameters
tenantId
required
string

ID of the tenant under which the service account was created.

Request Body schema: application/json
required
clientId
string

Unique identifier generated at the time of service account creation.

clientSecret
string

Secret key generated at the time of service account creation.

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}