Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

IAMService

ListIAM API lists the role bindings.

query Parameters
actorId
string

Actor ID for which the IAM should be listed.

accountId
string

Account UID for which the IAM should be listed.

tenantId
string

Tenant (Organization) UID for which the IAM should be listed.

projectId
string

Project UID for which the IAM should be listed.

sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "EMAIL"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • EMAIL: Sorting based on the email of the iam.
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.

tenantUid
required
string

Tenant (Organization) UID for which the IAM should be listed.

projectUid
string

Project UID for which the IAM should be listed.

Responses

Response samples

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

CreateIAM API creates a new IAM role-binding.

Request Body schema: application/json
required

IAM to be created

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Config represents the details of the data for IAM across different levels.

Responses

Request samples

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

Response samples

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

ListIAMPermissions API list permissions for Roles in IAM.

query Parameters
tenantId
required
string

Tenant (Organization) ID in context to which the permissions of the user to be listed.

projectId
string

permission request is to list the permissions of the user on given project.

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

GetIAM API returns the info about IAM for given IAM id.

path Parameters
actorId
required
string

Actor ID for which the details need to be fetched.

Responses

Response samples

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

DeleteIAM API delete IAM, currently required only for name.

path Parameters
actorId
required
string

Actor ID for which the IAM should be deleted.

Responses

Response samples

Content type
application/json
{ }

GrantIAM API creates new IAM role-binding at Tenant (Organization), project and account level.

path Parameters
actorId
required
string

actorId is UID of user/serviceAccount for we want to add new role in the IAM

Request Body schema: application/json
required
accountId
string

Account UID under which user wants to add role binding.

tenantId
string

Tenant (Organization) UID under which user wants to add role binding.

projectId
string

Project UID under which user wants to add role binding.

object (v1AccessPolicy)

Access Policy controls access to control plane resources. With IAM, one can centrally manage permissions that control which resources users can access.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "tenantId": "string",
  • "projectId": "string",
  • "accessPolicy": {
    }
}

Response samples

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

RevokeIAM API delete IAM role-binding at Tenant (Organization), project and account level.

path Parameters
actorId
required
string

actorId is UID of user/serviceAccount for we want to revoke role in the IAM

Request Body schema: application/json
required
accountId
string

Account UID under which user wants to delete role .

tenantId
string

Tenant (Organization) UID under which user wants to delete role .

projectId
string

Project UID under which user wants to delete role .

object (v1AccessPolicy)

Access Policy controls access to control plane resources. With IAM, one can centrally manage permissions that control which resources users can access.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "tenantId": "string",
  • "projectId": "string",
  • "accessPolicy": {
    }
}

Response samples

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

UpdateIAM API updates IAM with the new set of role bindings. The request replaces the existing set of bindings.

path Parameters
iam.meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

IAM to be updated.

object (Metadata for IAM.)

Metadata for IAM.

object (v1Config)

Config represents the details of the data for IAM across different levels.

Responses

Request samples

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

Response samples

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