Authentication

https://api.spectrocloud.com/v1alpha1/auth/authenticate

summary:
Authenticates the user for the specified crendentials
description:
Authenticates the user
Parameters:
NameTypeDescriptionRequired
setCookiebooleanno
{
"emailId": "string",
"password": "string"
}
200
OK
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1alpha1/auth/cookie/refresh

summary:
Refreshes authentication token using the cookie data
200
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
{
"appEnv": "string",
"authType": "string",
"orgName": "string",
"redirectUrl": "string",
"totalTenants": "number"
}

https://api.spectrocloud.com/v1alpha1/auth/logout

summary:
Logs out the user
description:
Logs out the user
204
Ok reponse without content

https://api.spectrocloud.com/v1alpha1/auth/org

summary:
Returns the user organization details
200
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 authentication
Parameters:
NameTypeDescriptionRequired
SAMLResponsestringno
Path parameters:
NameTypeDescriptionRequired
orgstringyes
authTokenstringno
200
OK
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1alpha1/auth/password/{passwordToken}/activate

summary:
Activates the specified user password using the password token
Path parameters:
NameTypeDescriptionRequired
passwordTokenstringyes
{
"password": "string"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1alpha1/auth/password/{passwordToken}/reset

summary:
Resets the user password using the password token
Path parameters:
NameTypeDescriptionRequired
passwordTokenstringyes
{
"password": "string"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1alpha1/auth/refresh/{token}

summary:
Refreshes authentication token
description:
Issues a new token within refresh timeout and same session id is maintained
Path parameters:
NameTypeDescriptionRequired
setCookiebooleanno
tokenstringyes
200
OK
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1alpha1/auth/services/login

summary:
System service authentication
description:
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
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1alpha1/auth/sso/idps

summary:
Returns the list of supported identity providers
200
(empty)
{
"items": {
"id": "string",
"name": "string"
}
}

https://api.spectrocloud.com/v1alpha1/auth/syslogin

summary:
System admin login
Parameters:
NameTypeDescriptionRequired
setCookiebooleanno
{
"emailId": "string",
"password": "string",
"username": "string"
}
200
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