Operators

List, create, read and update the operators who sign in to your Exsited instance.

An operator is a user of your instance. Here you list, create, read and update operators. This area has 4 endpoints, and every SDK supports all of them.

At a glance

Endpoint	Method	Path	What it does
List operators	GET	/settings/operators	Lists your operators, a page at a time.
Create an operator	POST	/settings/operators	Creates an operator and returns it under operator.
Retrieve an operator	GET	/settings/operators/{operator_id}	Returns one operator, under operator.
Update an operator	PATCH	/settings/operators/{operator_id}	Changes an operator’s name, display name, role or operator group.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Each operator’s id starts with op_. List operators returns each operator’s id.
• One operator comes back under operator; a listing comes back under data. A listing also carries pagination; pass pagination.next_cursor as cursor while has_more is true.
• role and operator_group are dashed uuids such as 3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73. The rol_ id and the same value without dashes are refused.
• An update refuses description as not understood. Send name, display_name, role or operator_group.