Authentication

Authenicate with our API by using Javascript Web Tokens or JWT for short.

/token

POST Generate token

{{base_url}}/v1/auth/token?app=

Example Request:

curl --location --request POST "{{base_url}}/v1/auth/token?app=" \
--header "Content-Type: application/x-www-form-urlencoded" \
--header "Accept: application/json" \
--data "username=admin&password=cloudcheckrfinancemanager"

HEADERS

Content-Type

application/x-www-form-urlencoded

Accept

application/json

PARAMS

app

The client to retrieve the state for. Leave empty to not retrieve state (default), or specify glass, lens.

BODY

(urlencoded)

username

admin

string

password

clouddcheckr

PATCH Refresh token

{{base_url}}/v1/auth/token?app=

Example Request:

curl --location --request PATCH "{{base_url}}/v1/auth/token?app=" \
--header "Accept: application/json" \
--data ""

HEADERS

Accept

application/json

PARAMS

app

The client to retrieve the state for. Leave empty to not retrieve state (default), or specify glass, lens.

BODY

(urlencoded)


/saml

Endpoints for supporting Single Sign-On authentication flow using SAML.

GET Initiate SAML login request

{{base_url}}/v1/auth/saml/login?return_url=

Redirects to SAML Identity Provider SSO URL set in the SAML configuration. After a successful authentication (possibly interactive), it will redirect back to this APIs ACS endpoint.

Example Request:

curl --location --request POST "{{base_url}}/v1/auth/saml/login?return_url=" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \

HEADERS

Content-Type

application/json

Accept

application/json

PARAMS

return_url

GET Initiate SAML logout request

{{base_url}}/v1/auth/saml/logout?return_url=

Redirects to SAML Identity Provider SLO URL set in the SAML configuration. After the user has been logged out, it will redirect back to this APIs SLS endpoint.

Example Request:

curl --location --request GET "{{base_url}}/v1/auth/saml/logout?return_url="
            
           

PARAMS

return_url

Glass URL to return to after logging out. If not specified, inferred from Referer header.

BODY

(formdata)

GET Entity ID endpoint

{{base_url}}/v1/auth/saml/metadata

Example Request:

curl --location --request GET "{{base_url}}/v1/auth/saml/metadata"
            

Metadata URL

BODY

(formdata)

POST ACS endpoint

{{base_url}}/v1/auth/saml/acs

Assertion Consumer Service. If the received response from the SAML Identity Provider is valid, redirects to the dashboard.

Example Request:

curl --location --request POST "{{base_url}}/v1/auth/saml/acs"
            

BODY

(formdata)

GET SLS endpoint

{{base_url}}/v1/auth/saml/sls

Single Logout Service. If the received response from the SAML Identity Provider is valid, redirects back to the login screen.

Example Request:

curl --location --request GET "{{base_url}}/v1/auth/saml/sls"
            

Metadata URL

BODY

(formdata)


/resetpassword

POST Request a password reset

{{base_url}}/v1/auth/resetpassword

Example Request:

curl --location --request POST "{{base_url}}/v1/auth/resetpassword" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
\"email_address\": \"{{email_address}}\"
}"

HEADERS

Accept

application/json

Content-Type

application/json

BODY (raw)

{
"email_address": "{{email_address}}"
}

PUT Perform a password reset

{{base_url}}/v1/auth/resetpassword

Using token sent in email

Example Request:

curl --location --request PUT "{{base_url}}/v1/auth/resetpassword" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"token\": \"{{reset_token}}\",
\"username\": \"{{username}}\",
\"password\": \"{{password}}\",
\"password_confirmation\": \"{{password_confirmation}}\"
}"

HEADERS

Content-Type

application/json

Accept

application/json

BODY (raw)

{
"token": "{{reset_token}}",
"username": "{{username}}",
"password": "{{password}}",
"password_confirmation": "{{password_confirmation}}"
}

GET Play pong

{{base_url}}/v1/auth/ping

Example Request:

curl --location --request GET "{{base_url}}/v1/auth/ping"
            

BODY

(formdata)


How did we do?