Auth

To Fetch Auth Token for a Host

post

Body

application/json

idstringOptional

macaddressstringOptional

passwordstringOptional

Responses

200

OK

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/api/hosts/adm/authenticate

HTTPcURLJavaScriptPython

POST /api/hosts/adm/authenticate HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "id": "text",
  "macaddress": "text",
  "password": "text"
}

{
  "code": 1,
  "message": "text",
  "response": null
}

Verify and complete setting up TOTP 2FA for a user

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username

Body

application/json

otp_auth_urlstringOptional

otp_auth_url_signaturestringOptional

totpstringOptional

Responses

200

OK

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/{username}/auth/complete-totp

HTTPcURLJavaScriptPython

POST /api/users/{username}/auth/complete-totp HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "otp_auth_url": "text",
  "otp_auth_url_signature": "text",
  "totp": "text"
}

{
  "code": 1,
  "message": "text",
  "response": null
}

Initiate setting up TOTP 2FA for a user

post

Authorizations

oauth

Path parameters

usernamestringRequired

Username

Responses

200

OK

application/json

otp_auth_urlstringOptional

otp_auth_url_signaturestringOptional

qr_codestringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/users/{username}/auth/init-totp

HTTPcURLJavaScriptPython

POST /api/users/{username}/auth/init-totp HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "otp_auth_url": "text",
  "otp_auth_url_signature": "text",
  "qr_code": "text"
}

Verify a user's TOTP token

post

Path parameters

usernamestringRequired

Username

Body

application/json

otp_auth_urlstringOptional

otp_auth_url_signaturestringOptional

totpstringOptional

Responses

200

OK

application/json

authTokenstringOptional

userNamestringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/api/users/{username}/auth/verify-totp

HTTPcURLJavaScriptPython

POST /api/users/{username}/auth/verify-totp HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "otp_auth_url": "text",
  "otp_auth_url_signature": "text",
  "totp": "text"
}

{
  "authToken": "text",
  "userName": "text"
}

Authenticate a user to retrieve an authorization token

post

Body

application/json

passwordstringOptional

usernamestringOptional

Responses

200

OK

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/api/users/adm/authenticate

HTTPcURLJavaScriptPython

POST /api/users/adm/authenticate HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "password": "text",
  "username": "text"
}

{
  "code": 1,
  "message": "text",
  "response": null
}