Users

Parameters

The users structure contains an integer parameter named acl. This represents the user's Access Level.

When setting this value through the API, the allowable range is from 1 to 20:

• 1-10 is a WAAP Viewer.

• 11-20 is a WAAP Editor.

Users can also have an acl value in the range 21-100. This is a WAAP manager.

The WAAP manager access level cannot be assigned to a user through the API. If you need to do this, contact support.

Operations

Get list of users

get

Responses

200

Users were retrieved successfully

application/json

idstringRequired

namestringRequired

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/accounts/users

HTTPcURLJavaScriptPython

GET /api/v4.3/accounts/users HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "users": [
      {
        "acl": 1,
        "contact_name": "text",
        "email": "[e-mail]",
        "id": "text",
        "mobile": "text",
        "org_id": "text",
        "org_name": "text"
      }
    ]
  }
]

Create new user

post

Create new user

Body

application/json

aclinteger · max: 20Required

contact_namestringRequired

emailstring · emailRequired

mobilestringRequired

org_idstringRequired

Responses

200

New user was created successfully

application/json

idstringRequired

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post/api/v4.3/accounts/users

HTTPcURLJavaScriptPython

POST /api/v4.3/accounts/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "acl": 1,
  "contact_name": "text",
  "email": "[e-mail]",
  "mobile": "text",
  "org_id": "text"
}

{
  "id": "text"
}

Get user details

get

Path parameters

entry_idstringRequired

Account ID

Responses

200

User details were retrieved successfully

application/json

aclinteger · max: 20Required

contact_namestringRequired

emailstring · emailRequired

idstringRequired

mobilestringRequired

org_idstringRequired

org_namestringRequired

otpseedstringRequired

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/accounts/{entry_id}

HTTPcURLJavaScriptPython

GET /api/v4.3/accounts/{entry_id} HTTP/1.1
Accept: */*

{
  "acl": 1,
  "contact_name": "text",
  "email": "[e-mail]",
  "id": "text",
  "mobile": "text",
  "org_id": "text",
  "org_name": "text",
  "otpseed": "text"
}

Modify user

put

Update details of a user

Path parameters

entry_idstringRequired

Account ID

Body

application/json

aclinteger · max: 20Required

contact_namestringRequired

mobilestringRequired

Responses

200

User updated successfully

application/json

anyOptional

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

put/api/v4.3/accounts/{entry_id}

HTTPcURLJavaScriptPython

PUT /api/v4.3/accounts/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "acl": 1,
  "contact_name": "text",
  "mobile": "text"
}

No content

Delete user

delete

Delete user by user id

Path parameters

entry_idstringRequired

Account ID

Responses

200

User was deleted successfully

application/json

anyOptional

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete/api/v4.3/accounts/{entry_id}

HTTPcURLJavaScriptPython

DELETE /api/v4.3/accounts/{entry_id} HTTP/1.1
Accept: */*

No content

Get all API keys associated with the planet

get

Responses

200

API keys received successfully

application/json

totalintegerOptionalExample: 1

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/accounts/api-keys

HTTPcURLJavaScriptPython

GET /api/v4.3/accounts/api-keys HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "account_id": "text",
      "created_by": "text",
      "created_time": 1,
      "email": "text",
      "id": "text",
      "key": "text",
      "title": "text"
    }
  ]
}

Delete an API key

put

Revokes API key and makes it unavailable for use

Path parameters

entry_idstringRequired

API key ID

Responses

200

API key was revoked successfully

application/json

anyOptional

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

put/api/v4.3/accounts/api-keys/{entry_id}

HTTPcURLJavaScriptPython

PUT /api/v4.3/accounts/api-keys/{entry_id} HTTP/1.1
Accept: */*

No content

Get API keys for a user

get

Path parameters

entry_idstringRequired

Account ID

Responses

200

API keys for specified user were retrieved successfully

application/json

totalintegerOptionalExample: 1

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/accounts/{entry_id}/api-keys

HTTPcURLJavaScriptPython

GET /api/v4.3/accounts/{entry_id}/api-keys HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "account_id": "text",
      "created_by": "text",
      "created_time": 1,
      "email": "text",
      "id": "text",
      "key": "text",
      "title": "text"
    }
  ]
}

Generate an API key for a user

post

Path parameters

entry_idstringRequired

Account ID

Body

application/json

titlestring · min: 1Required

Responses

200

API key for specified user was generated successfully

application/json

anyOptional

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post/api/v4.3/accounts/{entry_id}/api-keys

HTTPcURLJavaScriptPython

POST /api/v4.3/accounts/{entry_id}/api-keys HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

No content

Get SSO Config for the planet

get

Responses

200

SSO config retrieved successfully

application/json

enabledbooleanOptional

Is that profile enabled or not.

Default: false

paramsany ofRequired

SSO provider parameters

or

protocolstring · enumRequiredPossible values:

providerstring · enumRequired

An enumeration.

Possible values:

titlestringRequired

Title of the SSO profile that will be displayed on the login page.

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/accounts/sso

HTTPcURLJavaScriptPython

GET /api/v4.3/accounts/sso HTTP/1.1
Accept: */*

{
  "enabled": false,
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles": [
      {
        "idp_group": "text",
        "waap_groups": [
          "waap-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "token_expiration_threshold": 1
  },
  "protocol": "tcp",
  "provider": "okta",
  "title": "text"
}

Add/Update SSO Config of OAuth2 protocol for the planet

post

Body

application/json

enabledbooleanOptional

Is that profile enabled or not.

Default: false

protocolstring · enumRequiredPossible values:

providerstring · enumRequired

An enumeration.

Possible values:

titlestringRequired

Title of the SSO profile that will be displayed on the login page.

Responses

201

SSO config was updated successfully

application/json

cert_thumbprintstringOptional

Certificate thumbprint to show user certificate if correct. Is used only for user output.

codeintegerRequired

messagestringRequired

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post/api/v4.3/accounts/sso/oauth2

HTTPcURLJavaScriptPython

POST /api/v4.3/accounts/sso/oauth2 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "enabled": false,
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles": [
      {
        "idp_group": "text",
        "waap_groups": [
          "waap-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "token_expiration_threshold": 1
  },
  "protocol": "tcp",
  "provider": "okta",
  "title": "text"
}

{
  "cert_thumbprint": "text",
  "code": 1,
  "message": "text"
}

Add/Update SSO Config of SAML2 protocol for the planet

post

Body

application/json

enabledbooleanOptional

Is that profile enabled or not.

Default: false

protocolstring · enumRequiredPossible values:

providerstring · enumRequired

An enumeration.

Possible values:

titlestringRequired

Title of the SSO profile that will be displayed on the login page.

Responses

201

SSO config was updated successfully

application/json

cert_thumbprintstringOptional

Certificate thumbprint to show user certificate if correct. Is used only for user output.

codeintegerRequired

messagestringRequired

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post/api/v4.3/accounts/sso/saml2

HTTPcURLJavaScriptPython

POST /api/v4.3/accounts/sso/saml2 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "enabled": false,
  "params": {
    "entityId": "text",
    "login_url": "https://example.com",
    "roles": [
      {
        "idp_group": "text",
        "waap_groups": [
          "waap-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "tenantId": "text",
    "token_expiration_threshold": 1,
    "x509cert": "text"
  },
  "protocol": "tcp",
  "provider": "okta",
  "title": "text"
}

{
  "cert_thumbprint": "text",
  "code": 1,
  "message": "text"
}