→
https://api.spectrocloud.com/v1alpha1/auth/authenticate
summary:
Authenticates the user for the specified crendentialsdescription:
Authenticates the userParameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | no |
{"emailId": "string","password": "string"}
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1alpha1/auth/cookie/refresh
summary:
Refreshes authentication token using the cookie data 200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1alpha1/auth/login
summary:
Returns the authentication type for the specified user email id{"emailId": "string"}
200
OK
OK
{"appEnv": "string","authType": "string","orgName": "string","redirectUrl": "string","totalTenants": "number"}
→
https://api.spectrocloud.com/v1alpha1/auth/logout
summary:
Logs out the userdescription:
Logs out the user 204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1alpha1/auth/org
summary:
Returns the user organization details 200
OK
OK
{"appEnv": "string","authType": "string","orgName": "string","redirectUrl": "string","totalTenants": "number"}
→
https://api.spectrocloud.com/v1alpha1/auth/org/{org}/saml/callback
summary:
Identity provider callback url for the SMAL authenticationParameters:
Name | Type | Description | Required |
---|---|---|---|
SAMLResponse | string | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | yes | |
authToken | string | no |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1alpha1/auth/org/{org}/state
summary:
Checks the org statePath parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | yes |
200
OK
OK
{"state": "string"}
→
https://api.spectrocloud.com/v1alpha1/auth/password/{passwordToken}/activate
summary:
Activates the specified user password using the password tokenPath parameters:
Name | Type | Description | Required |
---|---|---|---|
passwordToken | string | yes |
{"password": "string"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/auth/password/{passwordToken}/reset
summary:
Resets the user password using the password tokenPath parameters:
Name | Type | Description | Required |
---|---|---|---|
passwordToken | string | yes |
{"password": "string"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/auth/refresh/{token}
summary:
Refreshes authentication tokendescription:
Issues a new token within refresh timeout and same session id is maintainedPath parameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | no | |
token | string | yes |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1alpha1/auth/services/login
summary:
System service authenticationdescription:
System service like ally, jet can login to get the JWT for the application interactions{"isSystem": "boolean","serviceName": "string","spectroClusterUid": "string","tenantUid": "string"}
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1alpha1/auth/sso/idps
summary:
Returns the list of supported identity providers 200
(empty)
(empty)
{"items": {"id": "string","name": "string"}}
→
https://api.spectrocloud.com/v1alpha1/auth/syslogin
summary:
System admin loginParameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | no |
{"emailId": "string","password": "string","username": "string"}
200
OK
OK
{"Authorization": "string","IsPasswordReset": "boolean"}
→
https://api.spectrocloud.com/v1alpha1/auth/user/password/reset
summary:
Resets the user password via email. Password reset email will be sent to the user{"emailId": "string"}
204
Ok reponse without content
Ok reponse without content