→
https://api.spectrocloud.com/v1/auth/authenticate
summary:
Authenticates the user for the specified crendentialsdescription:
Authenticates the userParameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | 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 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:
switches organisation for the user if user belongs to particular orgdescription:
switches organisation for the user if user belongs to particular orgParameters:
Name | Type | Description | Required |
---|---|---|---|
setCookie | boolean | no | |
orgName | string | yes |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/org/{org}/oidc/callback
summary:
Idp authorization code callbackPath parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | yes | |
code | string | no | |
state | string | no | |
error | string | no | |
error_description | string | no |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/org/{org}/oidc/logout
summary:
Identity provider logout url for the OidcPath parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | yes | |
state | string | no |
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1/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/v1/auth/org/{org}/saml/logout
summary:
Identity provider logout url for the SMALParameters:
Name | Type | Description | Required |
---|---|---|---|
SAMLResponse | string | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
org | string | yes | |
authToken | string | no |
204
Ok reponse without content
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
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 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/v1/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/v1/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/v1/auth/sso/idps
summary:
Returns the list of supported identity providers 200
(empty)
(empty)
{"items": {"id": "string","name": "string"}}
→
https://api.spectrocloud.com/v1/auth/sso/logins
summary:
Returns the list of supported sso loginsParameters:
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 the 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:
sso authorization code callbackPath parameters:
Name | Type | Description | Required |
---|---|---|---|
ssoApp | string | yes | |
code | string | no | |
state | string | no | |
error | string | no | |
error_description | string | no |
200
OK
OK
{"Authorization": "string"}
→
https://api.spectrocloud.com/v1/auth/user/org/forgot
summary:
Send the user organization information via email.Parameters:
Name | Type | Description | Required |
---|---|---|---|
emailId | string | yes |
204
Ok reponse without content
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
Ok reponse without content