Users

PreviousTools NextHostile Bot Detection / RCSI

Last updated 5 months ago

Was this helpful?

Get list of users

get

/api/v4.0/accounts/users

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/users'

200

400

422

500

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

Users were retrieved successfully

Create new user

post

/api/v4.0/accounts/users

Body

aclAclrequired

contact_nameContact Namerequired

emailEmailrequired

mobileMobilerequired

org_idOrg Idrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/users' \
  --header 'Content-Type: application/json' \
  --data '{"acl":1,"contact_name":"text","email":"hello@example.com","mobile":"text","org_id":"text"}'

200

400

422

500

{
  "id": "text"
}

New user was created successfully

Get user details

get

/api/v4.0/accounts/{entry_id}

Path parameters

entry_idAccount IDrequired

Account ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/{entry_id}'

200

400

422

500

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

User details were retrieved successfully

Modify user

Update details of a user

put

/api/v4.0/accounts/{entry_id}

Path parameters

entry_idAccount IDrequired

Account ID

Body

aclAclrequired

contact_nameContact Namerequired

mobileMobilerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/accounts/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"acl":1,"contact_name":"text","mobile":"text"}'

200

400

422

500

No body

User updated successfully

Delete user

Delete user by user id

delete

/api/v4.0/accounts/{entry_id}

Path parameters

entry_idAccount IDrequired

Account ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/accounts/{entry_id}'

200

400

422

500

No body

User was deleted successfully

Get all API keys associated with the planet

get

/api/v4.0/accounts/api-keys

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/api-keys'

200

400

422

500

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

API keys received successfully

Delete an API key

Revokes API key and makes it unavailable for use

put

/api/v4.0/accounts/api-keys/{entry_id}

Path parameters

entry_idKey Idrequired

API key ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/accounts/api-keys/{entry_id}'

200

400

422

500

No body

API key was revoked successfully

Get API keys for a user

get

/api/v4.0/accounts/{entry_id}/api-keys

Path parameters

entry_idAccount IDrequired

Account ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/{entry_id}/api-keys'

200

400

422

500

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

API keys for specified user were retrieved successfully

Generate an API key for a user

post

/api/v4.0/accounts/{entry_id}/api-keys

Path parameters

entry_idAccount IDrequired

Account ID

Body

titleTitlerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/{entry_id}/api-keys' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text"}'

200

400

422

500

No body

API key for specified user was generated successfully

Get SSO Config for the planet

get

/api/v4.0/accounts/sso

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/accounts/sso'

200

400

422

500

{
  "enabled": false,
  "title": "text",
  "params": {
    "client_id": "text",
    "client_secret": "text",
    "issuer": "text",
    "roles_claim_key": "text",
    "token_expiration_threshold": 1,
    "roles": []
  },
  "protocol": "oauth2",
  "provider": "okta"
}

SSO config retrieved successfully

Add/Update SSO Config of OAuth2 protocol for the planet

post

/api/v4.0/accounts/sso/oauth2

Body

enabledEnabled

Is that profile enabled or not.

titleTitlerequired

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

paramsParamsrequired

SSO provider OAuth2 protocol parameters

protocolall ofrequired

SSO protocol

providerall ofrequired

SSO provider

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/sso/oauth2' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":false,"title":"text","params":{"client_id":"text","client_secret":"text","issuer":"text","roles":[]},"protocol":"oauth2","provider":"okta"}'

201

400

422

500

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

SSO config was updated successfully

Add/Update SSO Config of SAML2 protocol for the planet

post

/api/v4.0/accounts/sso/saml2

Body

enabledEnabled

Is that profile enabled or not.

titleTitlerequired

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

paramsParamsrequired

SSO provider SAML2 protocol parameters

protocolall ofrequired

SSO protocol

providerall ofrequired

SSO provider

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/accounts/sso/saml2' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":false,"title":"text","params":{"entityId":"text","login_url":"https://example.com","tenantId":"text","roles":[]},"protocol":"oauth2","provider":"okta"}'

201

400

422

500

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

SSO config was updated successfully