User Management (Core)
25Example: 25The key of the permission to filter by
The group of the permission to filter by
The Permissions
PermissionsResponse
The total number of (filtered) permissions
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested roles.
Role
The date when the role was created.
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The date when the role was last modified.
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
RoleForCreation
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The name of the role, which must be unique and is used to identify the role.
The created role.
Role
The date when the role was created.
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The date when the role was last modified.
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested role.
Role
The date when the role was created.
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The date when the role was last modified.
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
RoleForUpdate
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1The updated role, including all the updates made.
Role
The date when the role was created.
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The date when the role was last modified.
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
The deleted role.
Role
The date when the role was created.
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The date when the role was last modified.
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
RoleForPatch
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1The patched role, including all the updates made.
Role
The date when the role was created.
The custom attributes of the role, which can be used to store additional information.
The description of the role, which provides more details about its purpose.
The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).
The date when the role was last modified.
The name of the role, which must be unique and is used to identify the role.
The version of the role.
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
RoleSearchPayload
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
10The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
RolePaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
25Example: 25Order the users by this field
Filter the users by this facility
Include all admins in the result (only applicable if facilityId is set)
The users were successfully returned.
User
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Creation date of the user
The email of the user
john.doe@example.comFacilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
The first name of the user
JohnThe id of the user
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe last login timestamp of the user
Last modification date of the user
The last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The username of the user
johndoeVersion of the user
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
UserForCreation
The email of the user
john.doe@example.comThe first name of the user
JohnThe last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The password of the user
elephantMangoDance123The username of the user
johndoeThe users was successfully created.
User
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Creation date of the user
The email of the user
john.doe@example.comFacilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
The first name of the user
JohnThe id of the user
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe last login timestamp of the user
Last modification date of the user
The last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The username of the user
johndoeVersion of the user
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
The user.
User
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Creation date of the user
The email of the user
john.doe@example.comFacilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
The first name of the user
JohnThe id of the user
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe last login timestamp of the user
Last modification date of the user
The last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The username of the user
johndoeVersion of the user
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
The deleted user.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
No content
UserPatchActions
The version of the user to modify
1The modified user.
User
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Creation date of the user
The email of the user
john.doe@example.comFacilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
The first name of the user
JohnThe id of the user
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe last login timestamp of the user
Last modification date of the user
The last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The username of the user
johndoeVersion of the user
1Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
UserAssignedFacilityForCreation
The id of the assigned facility
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe facilities were successfully assigned to the user.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
No content
The roles of the user.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
No content
ModifyUserPersonalData
The new firstname of the user
PhilThe new lastname of the user
BisonThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Updating my data was successful.
User
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Creation date of the user
The email of the user
john.doe@example.comFacilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
The first name of the user
JohnThe id of the user
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe last login timestamp of the user
Last modification date of the user
The last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The username of the user
johndoeVersion of the user
1Your user is not allowed to operate against this API instance
User action was successfully executed.
User
This part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: Creation date of the user
The email of the user
john.doe@example.comFacilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted
The first name of the user
JohnThe id of the user
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fThe last login timestamp of the user
Last modification date of the user
The last name of the user
DoeThis part of the API is in Beta status. For details, see the API release lifecycle documentation.
ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)
de_DEPossible values: The username of the user
johndoeVersion of the user
1Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
A version conflict occurred.
The effective permissions of the user.
EffectivePermissionsResponse
User ID of the current user
Your user is not allowed to operate against this API instance
UserSearchPayload
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
10The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
UserPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Last updated

