Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Users

PreviousToolsNextHostile Bot Detection / LWCSI

Last updated 8 months ago

Was this helpful?

Get user details

get
Path parameters
entry_idstringRequired

Account ID

Responses
200
User details were retrieved successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "acl": 1,
  "contact_name": "text",
  "email": "name@gmail.com",
  "id": "text",
  "mobile": "text",
  "org_id": "text",
  "org_name": "text",
  "otpseed": "text"
}

Delete user

delete

Delete user by user id

Path parameters
entry_idstringRequired

Account ID

Responses
200
User was deleted successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
delete
DELETE /api/v4.0/accounts/{entry_id} HTTP/1.1
Host: 
Accept: */*

No content

Get all API keys associated with the planet

get
Responses
200
API keys received successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/api-keys HTTP/1.1
Host: 
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
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
put
PUT /api/v4.0/accounts/api-keys/{entry_id} HTTP/1.1
Host: 
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
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/{entry_id}/api-keys HTTP/1.1
Host: 
Accept: */*

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

Get SSO Config for the planet

get
Responses
200
SSO config retrieved successfully
application/json
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/sso HTTP/1.1
Host: 
Accept: */*

{
  "enabled": false,
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles": [
      {
        "idp_group": "text",
        "reblaze_groups": [
          "reblaze-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "token_expiration_threshold": 1
  },
  "protocol": "oauth2",
  "provider": "okta",
  "title": "text"
}
  • GETGet list of users
  • POSTCreate new user
  • GETGet user details
  • PUTModify user
  • DELETEDelete user
  • GETGet all API keys associated with the planet
  • PUTDelete an API key
  • GETGet API keys for a user
  • POSTGenerate an API key for a user
  • GETGet SSO Config for the planet
  • POSTAdd/Update SSO Config of OAuth2 protocol for the planet
  • POSTAdd/Update SSO Config of SAML2 protocol for the planet

Get list of users

get
Responses
200
Users were retrieved successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/accounts/users HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "users": [
      {
        "acl": 1,
        "contact_name": "text",
        "email": "name@gmail.com",
        "id": "text",
        "mobile": "text",
        "org_id": "text",
        "org_name": "text"
      }
    ]
  }
]

Create new user

post

Create new user

Body
aclinteger · max: 20Required
contact_namestringRequired
emailstring · emailRequired
mobilestringRequired
org_idstringRequired
Responses
200
New user was created successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/accounts/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "acl": 1,
  "contact_name": "text",
  "email": "name@gmail.com",
  "mobile": "text",
  "org_id": "text"
}
{
  "id": "text"
}

Modify user

put

Update details of a user

Path parameters
entry_idstringRequired

Account ID

Body
aclinteger · max: 20Required
contact_namestringRequired
mobilestringRequired
Responses
200
User updated successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
put
PUT /api/v4.0/accounts/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

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

Generate an API key for a user

post
Path parameters
entry_idstringRequired

Account ID

Body
titlestring · min: 1Required
Responses
200
API key for specified user was generated successfully
application/json
Responseany
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/accounts/{entry_id}/api-keys HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}
No content

Add/Update SSO Config of OAuth2 protocol for the planet

post
Body
enabledbooleanOptional

Is that profile enabled or not.

Default: false
paramsall ofRequired

SSO provider OAuth2 protocol parameters

protocolall ofRequired

SSO protocol

string · enumOptional

An enumeration.

Possible values:
providerall ofRequired

SSO provider

string · enumOptional

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
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/accounts/sso/oauth2 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "enabled": false,
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles": [
      {
        "idp_group": "text",
        "reblaze_groups": [
          "reblaze-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "token_expiration_threshold": 1
  },
  "protocol": "oauth2",
  "provider": "okta",
  "title": "text"
}
{
  "cert_thumbprint": "text",
  "code": 1,
  "message": "text"
}

Add/Update SSO Config of SAML2 protocol for the planet

post
Body
enabledbooleanOptional

Is that profile enabled or not.

Default: false
paramsall ofRequired

SSO provider SAML2 protocol parameters

protocolall ofRequired

SSO protocol

string · enumOptional

An enumeration.

Possible values:
providerall ofRequired

SSO provider

string · enumOptional

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
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/accounts/sso/saml2 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "enabled": false,
  "params": {
    "entityId": "text",
    "login_url": "https://example.com",
    "roles": [
      {
        "idp_group": "text",
        "reblaze_groups": [
          "reblaze-events-viewer"
        ]
      }
    ],
    "roles_claim_key": "text",
    "tenantId": "text",
    "token_expiration_threshold": 1,
    "x509cert": "text"
  },
  "protocol": "oauth2",
  "provider": "okta",
  "title": "text"
}
{
  "cert_thumbprint": "text",
  "code": 1,
  "message": "text"
}