> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/services/management.md).

# management

Audience: Programmer

## Queries

* [dataTypeBySlug](https://docs.pyck.cloud/graphql-api/queries/datatypebyslug.md) — Returns the latest non-deleted DataType version for the given slug within the caller's tenant, or null if no version exists.
* [dataTypeEntities](https://docs.pyck.cloud/graphql-api/queries/datatypeentities.md)
* [dataTypes](https://docs.pyck.cloud/graphql-api/queries/datatypes.md)
* [deviceLocations](https://docs.pyck.cloud/graphql-api/queries/devicelocations.md)
* [deviceUsers](https://docs.pyck.cloud/graphql-api/queries/deviceusers.md)
* [devices](https://docs.pyck.cloud/graphql-api/queries/devices.md)
* [disabledTenants](https://docs.pyck.cloud/graphql-api/queries/disabledtenants.md)
* [keyValues](https://docs.pyck.cloud/graphql-api/queries/keyvalues.md)
* [locations](https://docs.pyck.cloud/graphql-api/queries/locations.md)
* [managementServiceInfo](https://docs.pyck.cloud/graphql-api/queries/managementserviceinfo.md)
* [me](https://docs.pyck.cloud/graphql-api/queries/me.md)
* [nodeDataType](https://docs.pyck.cloud/graphql-api/queries/nodedatatype.md) — Fetches an object given its ID.
* [nodesDataType](https://docs.pyck.cloud/graphql-api/queries/nodesdatatype.md) — Lookup nodes by a list of IDs.
* [serviceRoles](https://docs.pyck.cloud/graphql-api/queries/serviceroles.md) — List the per-service roles that can be assigned to users (the fixed, seeded set).
* [tenants](https://docs.pyck.cloud/graphql-api/queries/tenants.md)
* [userServiceRoles](https://docs.pyck.cloud/graphql-api/queries/userserviceroles.md) — List the per-service roles currently assigned to a user within a tenant, read directly from Zitadel.
* [users](https://docs.pyck.cloud/graphql-api/queries/users.md)

## Mutations

* [assignRoles](https://docs.pyck.cloud/graphql-api/mutations/assignroles.md) — Assign one or more per-service roles to an existing user within a tenant.
* [checkInUserDevice](https://docs.pyck.cloud/graphql-api/mutations/checkinuserdevice.md)
* [checkOutUserDevice](https://docs.pyck.cloud/graphql-api/mutations/checkoutuserdevice.md)
* [createDataType](https://docs.pyck.cloud/graphql-api/mutations/createdatatype.md)
* [createDevice](https://docs.pyck.cloud/graphql-api/mutations/createdevice.md)
* [createLocation](https://docs.pyck.cloud/graphql-api/mutations/createlocation.md)
* [createUser](https://docs.pyck.cloud/graphql-api/mutations/createuser.md) — Creates a user-projection row.
* [deleteDataType](https://docs.pyck.cloud/graphql-api/mutations/deletedatatype.md)
* [deleteDevice](https://docs.pyck.cloud/graphql-api/mutations/deletedevice.md)
* [deleteKeyValue](https://docs.pyck.cloud/graphql-api/mutations/deletekeyvalue.md)
* [deleteLocation](https://docs.pyck.cloud/graphql-api/mutations/deletelocation.md)
* [deleteTenant](https://docs.pyck.cloud/graphql-api/mutations/deletetenant.md) — Manually delete a tenant by setting deleted\_at via soft-delete.
* [deleteUser](https://docs.pyck.cloud/graphql-api/mutations/deleteuser.md) — Soft-deletes a user-projection row.
* [generateJsonSchema](https://docs.pyck.cloud/graphql-api/mutations/generatejsonschema.md)
* [patchDeviceData](https://docs.pyck.cloud/graphql-api/mutations/patchdevicedata.md) — Apply RFC 6902 JSON Patch operations to the device's data field.
* [patchDeviceLocationData](https://docs.pyck.cloud/graphql-api/mutations/patchdevicelocationdata.md) — Apply RFC 6902 JSON Patch operations to the device location's data field.
* [patchLocationData](https://docs.pyck.cloud/graphql-api/mutations/patchlocationdata.md) — Apply RFC 6902 JSON Patch operations to the location's data field.
* [registerTenant](https://docs.pyck.cloud/graphql-api/mutations/registertenant.md)
* [removeRoles](https://docs.pyck.cloud/graphql-api/mutations/removeroles.md) — Remove one or more per-service roles from an existing user within a tenant.
* [restoreTenant](https://docs.pyck.cloud/graphql-api/mutations/restoretenant.md) — Restore a previously disabled tenant by clearing its deleted\_at flag.
* [sendCustomEvent](https://docs.pyck.cloud/graphql-api/mutations/sendcustomevent.md)
* [setDeviceLocation](https://docs.pyck.cloud/graphql-api/mutations/setdevicelocation.md)
* [setKeyValue](https://docs.pyck.cloud/graphql-api/mutations/setkeyvalue.md)
* [setTenantExpiry](https://docs.pyck.cloud/graphql-api/mutations/settenantexpiry.md) — Sets or clears the tenant's expiry timestamp.
* [setTenantUITemplate](https://docs.pyck.cloud/graphql-api/mutations/settenantuitemplate.md) — Sets the per-workflow UI bundle URL templates for the tenant (remoteWebUITemplate / remoteMobileUITemplate in tenant.data).
* [unsetDeviceLocation](https://docs.pyck.cloud/graphql-api/mutations/unsetdevicelocation.md)
* [updateDataType](https://docs.pyck.cloud/graphql-api/mutations/updatedatatype.md) — Updates an existing DataType in place.
* [updateDevice](https://docs.pyck.cloud/graphql-api/mutations/updatedevice.md)
* [updateLocation](https://docs.pyck.cloud/graphql-api/mutations/updatelocation.md)
* [updateUser](https://docs.pyck.cloud/graphql-api/mutations/updateuser.md) — Updates a user-projection row.

## Types

* [AssignRolesResponse](https://docs.pyck.cloud/graphql-api/types/assignrolesresponse.md)
* [CheckInUserDeviceOutput](https://docs.pyck.cloud/graphql-api/types/checkinuserdeviceoutput.md)
* [CheckOutUserDeviceOutput](https://docs.pyck.cloud/graphql-api/types/checkoutuserdeviceoutput.md)
* [CustomEvent](https://docs.pyck.cloud/graphql-api/types/customevent.md)
* [DataType](https://docs.pyck.cloud/graphql-api/types/datatype.md)
* [DataTypeConnection](https://docs.pyck.cloud/graphql-api/types/datatypeconnection.md) — A connection to a list of items.
* [DataTypeDeletePayload](https://docs.pyck.cloud/graphql-api/types/datatypedeletepayload.md)
* [DataTypeEdge](https://docs.pyck.cloud/graphql-api/types/datatypeedge.md) — An edge in a connection.
* [DeleteTenantResponse](https://docs.pyck.cloud/graphql-api/types/deletetenantresponse.md) — Result of a manually-triggered tenant delete.
* [Device](https://docs.pyck.cloud/graphql-api/types/device.md)
* [DeviceConnection](https://docs.pyck.cloud/graphql-api/types/deviceconnection.md) — A connection to a list of items.
* [DeviceDeletePayload](https://docs.pyck.cloud/graphql-api/types/devicedeletepayload.md)
* [DeviceEdge](https://docs.pyck.cloud/graphql-api/types/deviceedge.md) — An edge in a connection.
* [DeviceLocation](https://docs.pyck.cloud/graphql-api/types/devicelocation.md)
* [DeviceLocationConnection](https://docs.pyck.cloud/graphql-api/types/devicelocationconnection.md) — A connection to a list of items.
* [DeviceLocationDeletePayload](https://docs.pyck.cloud/graphql-api/types/devicelocationdeletepayload.md)
* [DeviceLocationEdge](https://docs.pyck.cloud/graphql-api/types/devicelocationedge.md) — An edge in a connection.
* [DeviceLocationOutput](https://docs.pyck.cloud/graphql-api/types/devicelocationoutput.md)
* [DeviceOutput](https://docs.pyck.cloud/graphql-api/types/deviceoutput.md)
* [DeviceUser](https://docs.pyck.cloud/graphql-api/types/deviceuser.md)
* [DeviceUserConnection](https://docs.pyck.cloud/graphql-api/types/deviceuserconnection.md) — A connection to a list of items.
* [DeviceUserEdge](https://docs.pyck.cloud/graphql-api/types/deviceuseredge.md) — An edge in a connection.
* [EntityEventsOutbox](https://docs.pyck.cloud/graphql-api/types/entityeventsoutbox.md)
* [GenerateJsonSchemaResponse](https://docs.pyck.cloud/graphql-api/types/generatejsonschemaresponse.md)
* [KeyValue](https://docs.pyck.cloud/graphql-api/types/keyvalue.md)
* [KeyValueConnection](https://docs.pyck.cloud/graphql-api/types/keyvalueconnection.md) — A connection to a list of items.
* [KeyValueDeletePayload](https://docs.pyck.cloud/graphql-api/types/keyvaluedeletepayload.md)
* [KeyValueEdge](https://docs.pyck.cloud/graphql-api/types/keyvalueedge.md) — An edge in a connection.
* [Location](https://docs.pyck.cloud/graphql-api/types/location.md)
* [LocationConnection](https://docs.pyck.cloud/graphql-api/types/locationconnection.md) — A connection to a list of items.
* [LocationDeletePayload](https://docs.pyck.cloud/graphql-api/types/locationdeletepayload.md)
* [LocationEdge](https://docs.pyck.cloud/graphql-api/types/locationedge.md) — An edge in a connection.
* [LocationOutput](https://docs.pyck.cloud/graphql-api/types/locationoutput.md)
* [PageInfo](https://docs.pyck.cloud/graphql-api/types/pageinfo.md) — Information about pagination in a connection.
* [RegisterTenantResponse](https://docs.pyck.cloud/graphql-api/types/registertenantresponse.md)
* [RemoveRolesResponse](https://docs.pyck.cloud/graphql-api/types/removerolesresponse.md)
* [RestoreTenantResponse](https://docs.pyck.cloud/graphql-api/types/restoretenantresponse.md) — Result of a manually-triggered tenant restore.
* [SendCustomEventResponse](https://docs.pyck.cloud/graphql-api/types/sendcustomeventresponse.md)
* [ServiceInfo](https://docs.pyck.cloud/graphql-api/types/serviceinfo.md)
* [ServiceRole](https://docs.pyck.cloud/graphql-api/types/servicerole.md) — An assignable per-service gate role.
* [SetTenantExpiryResponse](https://docs.pyck.cloud/graphql-api/types/settenantexpiryresponse.md) — Result of setTenantExpiry.
* [SetTenantUITemplateResponse](https://docs.pyck.cloud/graphql-api/types/settenantuitemplateresponse.md) — Result of setTenantUITemplate.
* [Tenant](https://docs.pyck.cloud/graphql-api/types/tenant.md)
* [TenantConnection](https://docs.pyck.cloud/graphql-api/types/tenantconnection.md) — A connection to a list of items.
* [TenantEdge](https://docs.pyck.cloud/graphql-api/types/tenantedge.md) — An edge in a connection.
* [User](https://docs.pyck.cloud/graphql-api/types/user.md)
* [UserConnection](https://docs.pyck.cloud/graphql-api/types/userconnection.md) — A connection to a list of items.
* [UserEdge](https://docs.pyck.cloud/graphql-api/types/useredge.md) — An edge in a connection.
* [UserProfile](https://docs.pyck.cloud/graphql-api/types/userprofile.md)
* [UserRoleTuple](https://docs.pyck.cloud/graphql-api/types/userroletuple.md)
* [UserTenants](https://docs.pyck.cloud/graphql-api/types/usertenants.md)

## Interfaces

* [NodeDataType](https://docs.pyck.cloud/graphql-api/interfaces/nodedatatype.md) — An object with an ID.

## Inputs

* [AssignRolesInput](https://docs.pyck.cloud/graphql-api/inputs/assignrolesinput.md)
* [CheckInUserDeviceInput](https://docs.pyck.cloud/graphql-api/inputs/checkinuserdeviceinput.md)
* [CheckOutUserDeviceInput](https://docs.pyck.cloud/graphql-api/inputs/checkoutuserdeviceinput.md)
* [CreateDataTypeInput](https://docs.pyck.cloud/graphql-api/inputs/createdatatypeinput.md) — CreateDataTypeInput is used for create DataType object.
* [CreateDeviceInput](https://docs.pyck.cloud/graphql-api/inputs/createdeviceinput.md) — CreateDeviceInput is used for create Device object.
* [CreateDeviceLocationInput](https://docs.pyck.cloud/graphql-api/inputs/createdevicelocationinput.md) — CreateDeviceLocationInput is used for create DeviceLocation object.
* [CreateDeviceUserInput](https://docs.pyck.cloud/graphql-api/inputs/createdeviceuserinput.md) — CreateDeviceUserInput is used for create DeviceUser object.
* [CreateKeyValueInput](https://docs.pyck.cloud/graphql-api/inputs/createkeyvalueinput.md) — CreateKeyValueInput is used for create KeyValue object.
* [CreateLocationInput](https://docs.pyck.cloud/graphql-api/inputs/createlocationinput.md) — CreateLocationInput is used for create Location object.
* [CreateUserInput](https://docs.pyck.cloud/graphql-api/inputs/createuserinput.md) — CreateUserInput is used for create User object.
* [CustomEventPayloadInput](https://docs.pyck.cloud/graphql-api/inputs/customeventpayloadinput.md)
* [DataTypeOrder](https://docs.pyck.cloud/graphql-api/inputs/datatypeorder.md) — Ordering options for DataType connections
* [DataTypeWhereInput](https://docs.pyck.cloud/graphql-api/inputs/datatypewhereinput.md) — DataTypeWhereInput is used for filtering DataType objects.
* [DeleteTenantInput](https://docs.pyck.cloud/graphql-api/inputs/deletetenantinput.md) — Input for deleteTenant.
* [DeviceLocationOrder](https://docs.pyck.cloud/graphql-api/inputs/devicelocationorder.md) — Ordering options for DeviceLocation connections
* [DeviceLocationWhereInput](https://docs.pyck.cloud/graphql-api/inputs/devicelocationwhereinput.md) — DeviceLocationWhereInput is used for filtering DeviceLocation objects.
* [DeviceOrder](https://docs.pyck.cloud/graphql-api/inputs/deviceorder.md) — Ordering options for Device connections
* [DeviceUserOrder](https://docs.pyck.cloud/graphql-api/inputs/deviceuserorder.md) — Ordering options for DeviceUser connections
* [DeviceUserWhereInput](https://docs.pyck.cloud/graphql-api/inputs/deviceuserwhereinput.md) — DeviceUserWhereInput is used for filtering DeviceUser objects.
* [DeviceWhereInput](https://docs.pyck.cloud/graphql-api/inputs/devicewhereinput.md) — DeviceWhereInput is used for filtering Device objects.
* [EntityEventsOutboxWhereInput](https://docs.pyck.cloud/graphql-api/inputs/entityeventsoutboxwhereinput.md) — EntityEventsOutboxWhereInput is used for filtering EntityEventsOutbox objects.
* [JSONPatchInput](https://docs.pyck.cloud/graphql-api/inputs/jsonpatchinput.md) — A single RFC 6902 JSON Patch operation.
* [KeyValueOrder](https://docs.pyck.cloud/graphql-api/inputs/keyvalueorder.md) — Ordering options for KeyValue connections
* [KeyValueWhereInput](https://docs.pyck.cloud/graphql-api/inputs/keyvaluewhereinput.md) — KeyValueWhereInput is used for filtering KeyValue objects.
* [LocationOrder](https://docs.pyck.cloud/graphql-api/inputs/locationorder.md) — Ordering options for Location connections
* [LocationWhereInput](https://docs.pyck.cloud/graphql-api/inputs/locationwhereinput.md) — LocationWhereInput is used for filtering Location objects.
* [RegisterTenantInput](https://docs.pyck.cloud/graphql-api/inputs/registertenantinput.md)
* [RemoveRolesInput](https://docs.pyck.cloud/graphql-api/inputs/removerolesinput.md)
* [RestoreTenantInput](https://docs.pyck.cloud/graphql-api/inputs/restoretenantinput.md) — Input for restoreTenant.
* [SendCustomEventInput](https://docs.pyck.cloud/graphql-api/inputs/sendcustomeventinput.md)
* [SetKeyValueInput](https://docs.pyck.cloud/graphql-api/inputs/setkeyvalueinput.md)
* [SetTenantExpiryInput](https://docs.pyck.cloud/graphql-api/inputs/settenantexpiryinput.md) — Input for setTenantExpiry.
* [SetTenantUITemplateInput](https://docs.pyck.cloud/graphql-api/inputs/settenantuitemplateinput.md) — Input for setTenantUITemplate.
* [TenantOrder](https://docs.pyck.cloud/graphql-api/inputs/tenantorder.md) — Ordering options for Tenant connections
* [TenantWhereInput](https://docs.pyck.cloud/graphql-api/inputs/tenantwhereinput.md) — TenantWhereInput is used for filtering Tenant objects.
* [UpdateDataTypeInput](https://docs.pyck.cloud/graphql-api/inputs/updatedatatypeinput.md) — UpdateDataTypeInput is used for update DataType object.
* [UpdateDeviceInput](https://docs.pyck.cloud/graphql-api/inputs/updatedeviceinput.md) — UpdateDeviceInput is used for update Device object.
* [UpdateDeviceLocationInput](https://docs.pyck.cloud/graphql-api/inputs/updatedevicelocationinput.md) — UpdateDeviceLocationInput is used for update DeviceLocation object.
* [UpdateDeviceUserInput](https://docs.pyck.cloud/graphql-api/inputs/updatedeviceuserinput.md) — UpdateDeviceUserInput is used for update DeviceUser object.
* [UpdateKeyValueInput](https://docs.pyck.cloud/graphql-api/inputs/updatekeyvalueinput.md) — UpdateKeyValueInput is used for update KeyValue object.
* [UpdateLocationInput](https://docs.pyck.cloud/graphql-api/inputs/updatelocationinput.md) — UpdateLocationInput is used for update Location object.
* [UpdateUserInput](https://docs.pyck.cloud/graphql-api/inputs/updateuserinput.md) — UpdateUserInput is used for update User object.
* [UserOrder](https://docs.pyck.cloud/graphql-api/inputs/userorder.md) — Ordering options for User connections
* [UserServiceRolesInput](https://docs.pyck.cloud/graphql-api/inputs/userservicerolesinput.md)
* [UserWhereInput](https://docs.pyck.cloud/graphql-api/inputs/userwhereinput.md) — UserWhereInput is used for filtering User objects.

## Enums

* [DataTypeOrderField](https://docs.pyck.cloud/graphql-api/enums/datatypeorderfield.md) — Properties by which DataType connections can be ordered.
* [DeviceLocationOrderField](https://docs.pyck.cloud/graphql-api/enums/devicelocationorderfield.md) — Properties by which DeviceLocation connections can be ordered.
* [DeviceOrderField](https://docs.pyck.cloud/graphql-api/enums/deviceorderfield.md) — Properties by which Device connections can be ordered.
* [DeviceUserOrderField](https://docs.pyck.cloud/graphql-api/enums/deviceuserorderfield.md) — Properties by which DeviceUser connections can be ordered.
* [JSONPatchOp](https://docs.pyck.cloud/graphql-api/enums/jsonpatchop.md) — RFC 6902 JSON Patch operation type.
* [JSONType](https://docs.pyck.cloud/graphql-api/enums/jsontype.md) — JSON type for casting extracted JSONB values during ordering.
* [KeyValueOrderField](https://docs.pyck.cloud/graphql-api/enums/keyvalueorderfield.md) — Properties by which KeyValue connections can be ordered.
* [LocationOrderField](https://docs.pyck.cloud/graphql-api/enums/locationorderfield.md) — Properties by which Location connections can be ordered.
* [OrderDirection](https://docs.pyck.cloud/graphql-api/enums/orderdirection.md) — Possible directions in which to order a list of items when provided an `orderBy` argument.
* [TenantOrderField](https://docs.pyck.cloud/graphql-api/enums/tenantorderfield.md) — Properties by which Tenant connections can be ordered.
* [TenantStatus](https://docs.pyck.cloud/graphql-api/enums/tenantstatus.md) — TenantStatus is enum for the field status
* [UserOrderField](https://docs.pyck.cloud/graphql-api/enums/userorderfield.md) — Properties by which User connections can be ordered.

## Scalars

* [Cursor](https://docs.pyck.cloud/graphql-api/scalars/cursor.md) — Define a Relay Cursor type: <https://relay.dev/graphql/connections.htm#sec-Cursor>
* [Map](https://docs.pyck.cloud/graphql-api/scalars/map.md) — The builtin Map type
* [Password](https://docs.pyck.cloud/graphql-api/scalars/password.md) — A secret string that the server keeps exactly as sent.
* [Time](https://docs.pyck.cloud/graphql-api/scalars/time.md) — The builtin Time type
* [UUID](https://docs.pyck.cloud/graphql-api/scalars/uuid.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/services/management.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
