NSns-api
Authentication/Access Token (Oauth - Username/Password)

Get Access Token after MFA include Passcode

Changed on

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

post/tokens

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/tokens
  • Auth
    none required

Request body

grant_type'mfa' | 'password' | 'refresh_token' required

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

client_idstring required

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

client_secretstring required

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

usernamestring 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.

passwordstring password required

This is the password for the user requesting access.

mfa_typestring 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'

mfa_vendorstring 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'

ns_id_type'subscriber' | 'level1' required

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

passcodestring required

This will be the 6 digit numberic passcode provided by a

access_tokenstring required

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

Response

usernamestring required
userstring required
territorystring required
domainstring required
sitestring
groupstring
departmentstring required
uidstring required
loginstring required
scopestring required
user_emailstring required
displayNamestring required
access_tokenstring required
expires_ininteger required
token_typestring required
refresh_tokenstring required
client_idstring required
apiversionstring required

Changes

  • bce16087d479Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      added the new required request property with a default value

    • info

      added the new required request property with a default value

    • info

      added the new required request property with a default value

    • info

      the request property default value changed from password to mfa