→
https://api.spectrocloud.com/v1/auth/authenticate
summary:
Authenticates the user for the specified crendentialsdescription:
Creates a authentication request with the specified credentialsParameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | Describes a way to set cookie from backend. | no |
{"emailId": "string","org": "string","password": "string"}
200
OK
OK
{"Authorization": "string"}
deprecated→
https://api.spectrocloud.com/v1/auth/login
summary:
Deprecated. Returns the authentication type for the specified user email iddescription:
Deprecated. Returns the authentication type for the specified user email id{"emailId": "string"}
200
OK
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 detailsdescription:
Returns the allowed login method and information with the organization detailsParameters:
Name | Type | Description | Required |
---|---|---|---|
orgName | string | no |
200
OK
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:
Creates a request to switch organizationdescription:
Creates a request to switch to the same user's other organization. Only possible if user belongs to multiple organizationParameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | Describes a way to set cookie from backend for switched organization | no |
orgName | string | Organization name for which switch request has to be created | yes |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/org/{org}/oidc/callback
summary:
Idp authorization code callbackdescription:
Returns the Authorization token for the palette. This is called by the IDP as a callback url after IDP authenticates the user with its server.Path parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | Organization name | yes |
code | string | Describes temporary and very short lived code sent by IDP to validate the token | no |
state | string | Describes a state to validate and associate request and response | no |
error | string | Describes a error code in case the IDP is not able to validate and authenticates the user | no |
error_description | string | Describes a error in case the IDP is not able to validate and authenticates the user | no |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/org/{org}/oidc/logout
summary:
Identity provider logout url for the Oidcdescription:
Returns No Content. Works as a callback url after the IDP logout from their server.Path parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | Organization name | yes |
state | string | Describes a state to validate and associate request and response | no |
204
Ok response without content
Ok response without content
→
https://api.spectrocloud.com/v1/auth/org/{org}/saml/callback
summary:
Identity provider callback url for the SMAL authenticationdescription:
Returns the Authorization token for the palette. This is called by the SAML based IDP as a callback url after IDP authenticates the user with its server.Parameters:
Name | Type | Description | Required |
---|---|---|---|
SAMLResponse | string | Describe the SAML compliant response sent by IDP which will be validated by Palette | no |
RelayState | string | Describes a state to validate and associate request and response | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | Organization name | yes |
authToken | string | Deprecated. | no |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/org/{org}/saml/logout
summary:
Identity provider logout url for the SMALdescription:
Returns No Content. Works as a callback url after the IDP logout from their server.Parameters:
Name | Type | Description | Required |
---|---|---|---|
SAMLResponse | string | Describe the SAML compliant response sent by IDP which will be validated by Palette to perform logout. | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | Organization name | yes |
authToken | string | Deprecated. | no |
204
Ok response without content
Ok response without content
→
https://api.spectrocloud.com/v1/auth/orgs
summary:
Returns a list of user's organizationsdescription:
Returns a list of user's organizations details and login methods 200
OK
OK
{"organizations": [{"authType": "string","name": "string","redirectUrl": "string","ssoLogins": {"items": {"displayName": "string","logo": "string","name": "string","redirectUri": "string"}}}]}
→
https://api.spectrocloud.com/v1/auth/password/{passwordToken}/activate
summary:
Updates and Activates the specified user password using the password tokendescription:
Updates and Activates user password with the help of password tokenPath parameters:
Name | Type | Description | Required |
---|---|---|---|
passwordToken | string | Describes the expirable password token for the user to be used for authentication of user | yes |
{"password": "string"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/auth/password/{passwordToken}/reset
summary:
Resets the user password using the password tokendescription:
Updates the new user password with the help of password tokenPath parameters:
Name | Type | Description | Required |
---|---|---|---|
passwordToken | string | Describes the expirable password token for the user to be used for authentication of user | yes |
{"password": "string"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/auth/refresh/{token}
summary:
Refreshes authentication tokendescription:
Returns a new token within refresh timeout and same session id is maintainedPath parameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | Describes a way to set cookie from backend. | no |
token | string | Non expired Authorization token | yes |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/sso/idps
summary:
Returns a list of predefined Identity Provider (IDP)description:
Returns a list of predefined Identity Provider (IDP) 200
(empty)
(empty)
{"items": {"id": "string","name": "string"}}
→
https://api.spectrocloud.com/v1/auth/sso/logins
summary:
Returns a list of supported sso loginsdescription:
Returns a list of supported sso logins and their authentication mechanismParameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | no |
200
(empty)
(empty)
{"items": {"displayName": "string","logo": "string","name": "string","redirectUri": "string"}}
→
https://api.spectrocloud.com/v1/auth/sso/providers
summary:
Returns a list of supported sso auth providersdescription:
Returns a list of supported sso auth providers 200
(empty)
(empty)
{"items": {"displayName": "string","logo": "string","name": "string","redirectUri": "string"}}
→
https://api.spectrocloud.com/v1/auth/sso/{ssoApp}/callback
summary:
Returns Authorization token. Works as a callback url for the system defined sso appsdescription:
Returns Authorization token. Works as a callback url for the system defined sso appsPath parameters:
Name | Type | Description | Required |
---|---|---|---|
ssoApp | string | Describes the sso app use to login into the system | yes |
code | string | Describes temporary and very short lived code sent by IDP to validate the token | no |
state | string | Describes a state to validate and associate request and response | no |
error | string | Describes a error code in case the IDP is not able to validate and authenticates the user | no |
error_description | string | Describes a error in case the IDP is not able to validate and authenticates the user | no |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/user/org/forgot
summary:
Returns No Content. Sends the user organization information via emaildescription:
Returns No Content. Sends the user organization(s) information via emailParameters:
Name | Type | Description | Required |
---|---|---|---|
emailId | string | Describes user's email id for sending organzation(s) details via email. | yes |
204
Ok response without content
Ok response without content
→
https://api.spectrocloud.com/v1/auth/user/password/reset
summary:
Creates request to reset password via emaildescription:
Creates request to reset password via email. Password reset email will be sent to the user. Sends 204 No Content.{"emailId": "string"}
204
Ok response without content
Ok response without content