public/portworx/platform/login/apiv1/login.proto (version not set)
Download OpenAPI specification:Download
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/jsonrequired
Request for getting the user ID token in exchange for the given username and password.
string User email. | |
password | string User password. |
Responses
Request samples
- Payload
Content type
application/json
{- "email": "string",
- "password": "string"
}
Response samples
- 200
- default
Content type
application/json
{- "idToken": "string",
- "refreshToken": "string",
- "claims": {
- "iss": "string",
- "sub": "string",
- "name": "string",
- "email": "string",
- "roles": [
- "string"
], - "groups": [
- "string"
]
}, - "expiresBy": "2019-08-24T14:15:22Z"
}
RefreshToken API returns an ID Token in exchange for a valid refresh token.
Request Body schema: application/jsonrequired
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
- Payload
Content type
application/json
{- "refreshToken": "string"
}
Response samples
- 200
- default
Content type
application/json
{- "idToken": "string",
- "refreshToken": "string",
- "claims": {
- "iss": "string",
- "sub": "string",
- "name": "string",
- "email": "string",
- "roles": [
- "string"
], - "groups": [
- "string"
]
}, - "expiresBy": "2019-08-24T14:15:22Z"
}