Partner Login Endpoint

curl --request POST \
  --url https://api.example.com/partner/login \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'Username=<string>' \
  --data 'Password=<string>' \
  --data 'GrantType=<string>' \
  --data 'Scope=<string>' \
  --data 'SecondsUntilExpire=<string>' \
  --data 'ClientId=<string>'

{
  "access_token": "<string>",
  "token_type": "<string>",
  "expires_in": 123,
  "refresh_token": "<string>",
  "client_id": "<string>"
}

Partner Login Endpoint

Endpoint for partners to login and receive an access token.

The ‘grant_type’ key indicates this is a password request in compliance with OAuth 2.0 principles.

The access token is important and is used to continue all future interaction with the API.

The optional refresh token is used to refresh the expiration time remaining back to the original value. The expiration value is generally 600 seconds (10 minutes).

Tokens can be renewed as often as needed by re-issuing the call to the ‘login’ endpoint using valid credentials if your API is not set up to handle refresh tokens.

Once a token has been returned, this ‘session’ token is used as authorization granting access to all of the API capabilities. The following endpoints access and manage the provisioning process through the primary URL: https://api.cyrisma.com/app

POST

partner

Partner Login Endpoint

curl --request POST \
  --url https://api.example.com/partner/login \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'Username=<string>' \
  --data 'Password=<string>' \
  --data 'GrantType=<string>' \
  --data 'Scope=<string>' \
  --data 'SecondsUntilExpire=<string>' \
  --data 'ClientId=<string>'

{
  "access_token": "<string>",
  "token_type": "<string>",
  "expires_in": 123,
  "refresh_token": "<string>",
  "client_id": "<string>"
}

Body

application/x-www-form-urlencoded

Form data for partner login.

Username

string

required

The username for partner login.

Minimum string length: 1

Password

string

required

The password for partner login.

Minimum string length: 1

GrantType

string

required

The grant type for partner login.

Minimum string length: 1

Scope

string | null

The grant type for partner login.

SecondsUntilExpire

string | null

The number of seconds until the token expires.

ClientId

string | null

The client ID for partner login.

Response

Represents a baseline target with its name and grade.

access_token

string | null

Access token for authentication.

token_type

string | null

Type of the token.

expires_in

integer<int32>

Expiration time of the token in seconds.

refresh_token

string | null

Refresh token for obtaining new access tokens.

client_id

string | null

Scope of the access token.

Convert Consulting To Standard Endpoint Reset Password Endpoint

Overview

Dashboards

Instances

Login

Scans

Users

Vulnerability Assets

Partner Login Endpoint

Body

Response