OrgsNAC IDP

validateOrgIdpCredential

POST
/api/v1/orgs/{org_id}/mist_nac/test_idp

IDP Credential Validation. The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.

Subscribe to Device Command outputs

WS /api-ws/v1/stream

{    "subscribe": "orgs/{org_id}/mist_nac/test_idp"}

Response (no idp can be found)

{    "event": "data",    "channel": "/orgs/{org_id}/mist_nac/test_idp",    "status":     "data": {        "status": "failure",        "error": "No matching IDP found"    }}

Response OK

{    "event": "data",    "channel": "/orgs/{org_id}/mist_nac/test_idp",    "status":     "data": {        "status": "success",        "idp_id": "915793c0-1355-4e98-b1c0-23df2227b357",        "idp_type": "ldap",        // more attributes will be added later    }}

Response Invalid Credentials

{    "event": "data",    "channel": "/orgs/{org_id}/mist_nac/test_idp",    "status":     "data": {        "status": "failure",        "error": "Invalid Credentials",        "idp_id": "915793c0-1355-4e98-b1c0-23df2227b357",        "idp_type": "ldap",    }}

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Request Body

application/json

Credential payload used to validate an identity provider login

password?string

Credential password used for the validation attempt

Formatpassword
username?string

Credential username used for the validation attempt

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mist_nac/test_idp" \  -H "Content-Type: application/json" \  -d '{    "password": "xxxxxx",    "username": "suriyas@juniper.net"  }'
{  "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}