Quorum Users

The endpoint for the Quorum Users adminstration on your account.

Retrieve multiple Quorum User accounts based on search critera passed as GET Arguments

get/api/user/

The endpoint for the Quorum Users adminstration on your account.

Securityapi_key and user_name
Request
query Parameters
date_joined
string <date-time>

NOTE: Parameter accepts additional qualifiers appended to the end:
date_joined__year, date_joined__month, date_joined__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

email
string

NOTE: Parameter accepts additional qualifiers appended to the end:
email__in - The value for the record is in the provided array parameter (comma-separated values).
email__contains, email__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
email__startswith, email__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
email__endswith, email__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
email__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

id
integer <int64>

Quorum ID (Primary Key)

is_active
boolean
username
string

NOTE: Parameter accepts additional qualifiers appended to the end:
username__in - The value for the record is in the provided array parameter (comma-separated values).
username__contains, username__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
username__startswith, username__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
username__endswith, username__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
username__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

limit
integer <int64>
Default: 20

The number of records to return (for pagination).

offset
integer <int64>
Default: 0

The number of records to offset the start of the data being returned (for pagination).

Responses
200

QuorumUser retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "first_name": "string",
  • "id": 0,
  • "is_active": true,
  • "last_name": "string",
  • "name": "string",
  • "resource_uri": "string",
  • "teams": [
    ],
  • "user_info": "/api/userinfo/1/",
  • "user_info__full_name": "string",
  • "user_info__organization__id": 0,
  • "user_info__organization__name": "string",
  • "user_info__two_factor_status": 0,
  • "username": "string"
}

Retrieve information on a single Quorum User account

get/api/user/{id}/

The endpoint for the Quorum Users adminstration on your account.

Securityapi_key and user_name
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Responses
200

QuorumUser retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "first_name": "string",
  • "id": 0,
  • "is_active": true,
  • "last_name": "string",
  • "name": "string",
  • "resource_uri": "string",
  • "teams": [
    ],
  • "user_info": "/api/userinfo/1/",
  • "user_info__full_name": "string",
  • "user_info__organization__id": 0,
  • "user_info__organization__name": "string",
  • "user_info__two_factor_status": 0,
  • "username": "string"
}

Update a single Quorum Users by ID

patch/api/user/{id}/

The endpoint for the Quorum Users adminstration on your account.

Securityapi_key and user_name
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Request Body schema: application/json
is_active
boolean
Responses
200

QuorumUser retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "is_active": true
}
Response samples
application/json
{
  • "_extra": { },
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "first_name": "string",
  • "id": 0,
  • "is_active": true,
  • "last_name": "string",
  • "name": "string",
  • "resource_uri": "string",
  • "teams": [
    ],
  • "user_info": "/api/userinfo/1/",
  • "user_info__full_name": "string",
  • "user_info__organization__id": 0,
  • "user_info__organization__name": "string",
  • "user_info__two_factor_status": 0,
  • "username": "string"
}