Authentication

→

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

summary:

Authenticates the user for the specified crendentials

description:

Creates a authentication request with the specified credentials

Parameters:

Name	Type	Description	Required
setCookie	boolean	Describes a way to set cookie from backend.	no

Body

{
  "emailId": "string",
  "org": "string",
  "password": "string"
}

HTTP code: 200
Description: OK
Response body:

{
  "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

Body

{
  "emailId": "string"
}

HTTP code: 200
Description: OK
Response body:

{
  "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

description:

Returns the allowed login method and information with the organization details

Parameters:

Name	Type	Description	Required
orgName	string		no

HTTP code: 200
Description: OK
Response body:

{
  "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 organization

description:

Creates a request to switch to the same user's other organization. Only possible if user belongs to multiple organization

Parameters:

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

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Idp authorization code callback

description:

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

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Identity provider logout url for the Oidc

description:

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

HTTP code: 204
Description: Ok response without content

→

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

summary:

Identity provider callback url for the SMAL authentication

description:

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

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Identity provider logout url for the SMAL

description:

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

HTTP code: 204
Description: Ok response without content

→

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

summary:

Returns a list of user's organizations

description:

Returns a list of user's organizations details and login methods

HTTP code: 200
Description: OK
Response body:

{
  "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 token

description:

Updates and Activates user password with the help of password token

Path parameters:

Name	Type	Description	Required
passwordToken	string	Describes the expirable password token for the user to be used for authentication of user	yes

Body

{
  "password": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Resets the user password using the password token

description:

Updates the new user password with the help of password token

Path parameters:

Name	Type	Description	Required
passwordToken	string	Describes the expirable password token for the user to be used for authentication of user	yes

Body

{
  "password": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Refreshes authentication token

description:

Returns a new token within refresh timeout and same session id is maintained

Path parameters:

Name	Type	Description	Required
setCookie	boolean	Describes a way to set cookie from backend.	no
token	string	Non expired Authorization token	yes

HTTP code: 200
Description: OK
Response body:

{
  "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)

HTTP code: 200
Description: (empty)
Response body:

{
  "items": {
    "id": "string",
    "name": "string"
  }
}

→

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

summary:

Returns a list of supported sso logins

description:

Returns a list of supported sso logins and their authentication mechanism

Parameters:

Name	Type	Description	Required
org	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "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 providers

description:

Returns a list of supported sso auth providers

HTTP code: 200
Description: (empty)
Response body:

{
  "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 apps

description:

Returns Authorization token. Works as a callback url for the system defined sso apps

Path 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

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Returns No Content. Sends the user organization information via email

description:

Returns No Content. Sends the user organization(s) information via email

Parameters:

Name	Type	Description	Required
emailId	string	Describes user's email id for sending organzation(s) details via email.	yes

HTTP code: 204
Description: Ok response without content

→

https://api.spectrocloud.com/v1/auth/user/password/reset

summary:

Creates request to reset password via email

description:

Creates request to reset password via email. Password reset email will be sent to the user. Sends 204 No Content.

Body

{
  "emailId": "string"
}

HTTP code: 204
Description: Ok response without content

Edit on GitHub