Get users or groups

GET 
/tenant/entities

Get a list of users or groups in your Blink tenant.

Request

Query Parameters

q string

For the RQL query syntax, visit our RQL query documentation in the RQL Format tab

Responses

200

OK

application/json

Schema

Schema

limit integer
offset integer
results object[]
Array [
auth_ids string[]
description string
email string
entity_id string
entity_type string
is_invite boolean
member_count integer
name string
role string
status string
]
total integer

Example (from schema)

{
  "limit": 0,
  "offset": 0,
  "results": [
    {
      "auth_ids": [
        "string"
      ],
      "description": "string",
      "email": "string",
      "entity_id": "string",
      "entity_type": "string",
      "is_invite": true,
      "member_count": 0,
      "name": "string",
      "role": "string",
      "status": "string"
    }
  ],
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

data
details string
identifier string
message string
status integer
user_error

Example (from schema)

{
  "data": {},
  "details": "string",
  "identifier": "string",
  "message": "string",
  "status": 404,
  "user_error": {}
}

404

Entity not found

application/json

Schema

Schema

data
details string
identifier string
message string
status integer
user_error

Example (from schema)

{
  "data": {},
  "details": "string",
  "identifier": "string",
  "message": "string",
  "status": 404,
  "user_error": {}
}

Loading...