Authentication

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

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

deprecated

https://api.spectrocloud.com/v1/auth/login

summary:
Deprecated. Returns the authentication type for the specified user email id
description:
Deprecated. Returns the authentication type for the specified user email id
{
"emailId": "string"
}
200
OK
{
"appEnv": "string",
"authType":deprecated "string",
"orgName":deprecated "string",
"orgs": [
{
"authType": "string",
"orgName": "string",
"redirectUrl": "string"
}
],
"redirectUrl":deprecated "string"
}

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

summary:
Returns the user organization details
Parameters:
NameTypeDescriptionRequired
orgNamestringno
200
OK
{
"appEnv": "string",
"authType": "string",
"orgName": "string",
"redirectUrl": "string",
"rootDomain": "string",
"ssoLogins": {
"items": {
"displayName": "string",
"logo": "string",
"name": "string",
"redirectUri": "string"
}
},
"totalTenants": "number"
}

https://api.spectrocloud.com/v1/auth/org/{orgName}/switch

summary:
switches organisation for the user if user belongs to particular org
description:
switches organisation for the user if user belongs to particular org
Parameters:
NameTypeDescriptionRequired
setCookiebooleanno
orgNamestringyes
200
OK
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1/auth/org/{org}/oidc/callback

summary:
Idp authorization code callback
Path parameters:
NameTypeDescriptionRequired
orgstringyes
codestringno
statestringno
errorstringno
error_descriptionstringno
200
OK
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1/auth/org/{org}/oidc/logout

summary:
Identity provider logout url for the Oidc
Path parameters:
NameTypeDescriptionRequired
orgstringyes
statestringno
204
Ok reponse without content

https://api.spectrocloud.com/v1/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/v1/auth/org/{org}/saml/logout

summary:
Identity provider logout url for the SMAL
Parameters:
NameTypeDescriptionRequired
SAMLResponsestringno
Path parameters:
NameTypeDescriptionRequired
orgstringyes
authTokenstringno
204
Ok reponse without content

https://api.spectrocloud.com/v1/auth/orgs

summary:
Returns the list of user associated organizations based on the authorization token.
200
OK
{
"organizations": [
{
"name": "string",
"redirectUrl": "string",
"ssoLogins": {
"items": {
"displayName": "string",
"logo": "string",
"name": "string",
"redirectUri": "string"
}
}
}
]
}

https://api.spectrocloud.com/v1/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/v1/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/v1/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/v1/auth/sso/idps

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

https://api.spectrocloud.com/v1/auth/sso/logins

summary:
Returns the list of supported sso logins
Parameters:
NameTypeDescriptionRequired
orgstringno
200
(empty)
{
"items": {
"displayName": "string",
"logo": "string",
"name": "string",
"redirectUri": "string"
}
}

https://api.spectrocloud.com/v1/auth/sso/providers

summary:
Returns the list of supported sso auth providers
200
(empty)
{
"items": {
"displayName": "string",
"logo": "string",
"name": "string",
"redirectUri": "string"
}
}

https://api.spectrocloud.com/v1/auth/sso/{ssoApp}/callback

summary:
sso authorization code callback
Path parameters:
NameTypeDescriptionRequired
ssoAppstringyes
codestringno
statestringno
errorstringno
error_descriptionstringno
200
OK
{
"Authorization": "string"
}

https://api.spectrocloud.com/v1/auth/user/org/forgot

summary:
Send the user organization information via email.
Parameters:
NameTypeDescriptionRequired
emailIdstringyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/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