Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

InvitationService

ListInvitation API lists invitation in an account/tenant/project.

query Parameters
accountId
string

Account UID to which the user has been invited. User can be invited to multiple accounts.

tenantId
string

Tenant UID to which the user has been invited. User can be invited to multiple tenants.

projectId
string

Project UID to which the user has been invited. User can be invited to multiple projects.

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
{
  • "invitations": [
    ],
  • "pagination": {
    }
}

CreateInvitation API creates an invitation.

Request Body schema: application/json
required

CreateInvitationRequest is the request message for invitation.

object (v1Invitation)

Invitation.

object (v1Meta)

Meta holds general resource metadata.

object (platforminvitationv1Config)

Config represents the configuration of the invitation.

object (invitationv1Status)

Status represents the current status of invitation.

Responses

Request samples

Content type
application/json
{
  • "invitation": {
    }
}

Response samples

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

GetInvitation deletes the specified invitation from the system.

path Parameters
uid
required
string

UID of the invitation.

Responses

Response samples

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

DeleteInvitation deletes the specified invitation from the system.

path Parameters
uid
required
string

UID is the unique ID of the invitation.

Responses

Response samples

Content type
application/json
{ }

Notify re-send the mail notification to the user email in the invitation config.

path Parameters
uid
required
string

UID of the invitation.

Responses

Response samples

Content type
application/json
{ }

AcceptInvitation API accepts the invitation from the system.

Request Body schema: application/json
required

AcceptInvitationRequest is the request message to accept an invitation.

accountId
required
string

we need to pass account_id in the body as for first time acceptance of request, user would not have the context of account.

Responses

Request samples

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

Response samples

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