Authentication

→

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

summary:

Authenticates the user for the specified crendentials

description:

Authenticates the user

Parameters:

Name	Type	Description	Required
setCookie	boolean		no

Body

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

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Refreshes authentication token using the cookie data

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

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/logout

summary:

Logs out the user

description:

Logs out the user

Parameters:

Name	Type	Description	Required
token	string		no

HTTP code: 200
Description: OK
Response body:

{
  "redirectUrl": "string"
}

HTTP code: 500
Description: (empty)

→

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

summary:

Returns the user organization details

HTTP code: 200
Description: OK
Response body:

{
  "appEnv": "string",
  "authType": "string",
  "orgName": "string",
  "redirectUrl": "string",
  "rootDomain": "string",
  "totalTenants": "number"
}

→

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

summary:

Idp authorization code callback

Path parameters:

Name	Type	Required
org	string	yes
code	string	no
state	string	no
error	string	no
error_description	string	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

Path parameters:

Name	Type	Description	Required
org	string		yes
state	string		no

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Identity provider callback url for the SMAL authentication

Parameters:

Name	Type	Description	Required
SAMLResponse	string		no

Path parameters:

Name	Type	Description	Required
org	string		yes
authToken	string		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

Parameters:

Name	Type	Description	Required
SAMLResponse	string		no

Path parameters:

Name	Type	Description	Required
org	string		yes
authToken	string		no

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Checks the org state

Path parameters:

Name	Type	Description	Required
org	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "state": "string"
}

→

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

summary:

Activates the specified user password using the password token

Path parameters:

Name	Type	Description	Required
passwordToken	string		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

Path parameters:

Name	Type	Description	Required
passwordToken	string		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:

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

Path parameters:

Name	Type	Description	Required
setCookie	boolean		no
token	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Edge service authentication

description:

Edge service like edge, lodge can login to get the JWT for the application interactions

Body

{
  "edgeHostUid": "string",
  "serviceName": "string",
  "tenantUid": "string"
}

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

System service authentication

description:

System service like ally, jet can login to get the JWT for the application interactions

Body

{
  "isSystem": "boolean",
  "serviceName": "string",
  "spectroClusterUid": "string",
  "tenantUid": "string"
}

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string"
}

→

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

summary:

Returns the list of supported identity providers

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

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

→

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

summary:

System admin login

Parameters:

Name	Type	Description	Required
setCookie	boolean		no

Body

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

HTTP code: 200
Description: OK
Response body:

{
  "Authorization": "string",
  "IsPasswordReset": "boolean"
}

→

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

Body

{
  "emailId": "string"
}

HTTP code: 204
Description: Ok reponse without content

Edit on GitHub