Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

LoginService

Login API interacts with central using provided email + password and returns an ID Token which can be used by the user for API authentication.

Request Body schema: application/json
required

Request for getting the user ID token in exchange for the given username and password.

email
string

User email.

password
string

User password.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "idToken": "string",
  • "refreshToken": "string",
  • "claims": {
    },
  • "expiresBy": "2019-08-24T14:15:22Z"
}

Logout API returns removes the session cookie of the user and invalidates the access token.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

GetOIDCInfo API returns an oidc configurations for user client.

Responses

Response samples

Content type
application/json
{
  • "issuer": "string",
  • "authUrl": "string",
  • "clientId": "string",
  • "redirectUrl": "string"
}

RefreshToken API returns an ID Token in exchange for a valid refresh token.

Request Body schema: application/json
required

Request for getting the user ID token in exchange for the given refresh token.

refreshToken
string

Special token used to obtain additional access token.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "idToken": "string",
  • "refreshToken": "string",
  • "claims": {
    },
  • "expiresBy": "2019-08-24T14:15:22Z"
}