Get Access Token after MFA request

This API will accept username and password along with a passcode generated via a authenticator application and generate a Access token

Request

Body Params application/json

grant_type

enum<string>

required

This is the type of authentication request being made. 'mfa' would be needed in the second request with MFA passcode.

Allowed values:

mfapasswordrefresh_token

Default:

mfa

client_id

string

required

This is the client_id provided to the developer for accessing the api. Will match with the client_secret

client_secret

string

required

This is the client_secret provided to the developer for accessing the api. Will match with the client_id

username

string

required

This is the username and logic for the user. This may look like a uid (user@domain) or could be something else if setup diffferent including a email address potentially.

password

string <password>

required

This is the password for the user requesting access.

mfa_type

string

required

This value will be provided in response to a auth request if MFA is needed. Move value from that token to this request. Likely will be 'authenticator'

Default:

authenticator

mfa_vendor

string

required

This value will be provided in response to a auth request if MFA is needed. Move value from that token to this request. Likely will be 'google'

Default:

google

ns_id_type

enum<string>

required

Will likely be subscriber as the value here to defierentiate between authenticator for api/portal and mfa with admin ui

Allowed values:

subscriberlevel1

Default:

subscriber

passcode

string

required

This will be the 6 digit numberic passcode provided by a

access_token

string

required

This will be the access_token or jwt that was given with the scope of mfa_required

Example

{
  "grant_type": "mfa",
  "client_id": "{{client_id}}",
  "client_secret": "{{client_secret}}",
  "username": "{{user_login}}",
  "password": "{{user_password}}",
  "mfa_vendor": "google",
  "mfa_type": "authenticator",
  "passcode": "110124",
  "ns_id_type": "subscriber",
  "access_token": "2711618e692064e183e9596a26e8eb10"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

username

string

required

user

string

required

territory

string

required

domain

string

required

site

string

required

group

string

required

department

string

required

uid

string

required

string

required

scope

string

required

user_email

string

required

displayName

string

required

access_token

string

required

expires_in

integer

required

token_type

string

required

refresh_token

string

required

client_id

string

required

apiversion

string

required

Example

{
  "username": "string",
  "user": "string",
  "territory": "string",
  "domain": "string",
  "site": "string",
  "group": "string",
  "department": "string",
  "uid": "string",
  "login": "string",
  "scope": "string",
  "user_email": "string",
  "displayName": "string",
  "access_token": "string",
  "expires_in": 0,
  "token_type": "string",
  "refresh_token": "string",
  "client_id": "string",
  "apiversion": "string"
}

🟠403Forbidden

🟠400Bad Request

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required