Retrieves all the access policies associated to the client apps in the context of a specified api resource and api scope.
| tenantUid required | string <uuid> The tenant identifier that client access policies belong to. |
| apiResource required | string The api resource associated to the access policies that clients have access to. |
| apiScope required | string The api scope associated to the resources that clients have access to. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Result": "success",
- "AccessPolicies": {
- "zy4I5dHA5tjMkgaeZBNmQShGpzP8vo": [
- "RMember",
- "WMember"
], - "dMJ8UyS8KCgsyKNC35bPYfjuZmuqFL": [
- "RRole",
- "WRole"
]
}
}Retrieves all the identity roles with theirs associates authorization access policies in the context of a specified tenant.
| tenantUid required | string <uuid> The tenant identifier that identity roles belong to. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Result": "success",
- "IdentityRoles": [
- {
- "Id": 1,
- "Key": "admin",
- "TenantId": 2,
- "ShortName": "System-Administrator",
- "LongName": "System-Administrator",
- "AllowAllPolicies": true,
- "AccessPolicies": [
- {
- "Id": 1,
- "Key": "AuthContact",
- "Name": "AuthContact"
}, - {
- "Id": 2,
- "Key": "AuthContactMobile",
- "Name": "AuthContactMobile"
}, - {
- "Id": 3,
- "Key": "AuthContactSso",
- "Name": "AuthContactSso"
}, - {
- "Id": 4,
- "Key": "AuthEnrollContact",
- "Name": "AuthEnrollContact"
}, - {
- "Id": 5,
- "Key": "AuthOnboardContact",
- "Name": "AuthOnboardContact"
}
]
}
]
}Retrieves a list of API access policies.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "accessPolicies": [
- {
- "id": 0,
- "key": "string",
- "name": "string"
}
]
}Retrieve a specific access policy.
| accessPolicyId required | integer <int32> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "id": 0,
- "key": "string",
- "name": "string",
- "description": "string",
- "isAppOriented": true,
- "requiredByPermissions": [
- {
- "id": 0,
- "uid": "string",
- "name": "string",
- "parentId": 0,
- "orderIndex": 0
}
]
}Retrieve a list of available system-wide permissions.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "results": [
- {
- "id": 0,
- "uid": "string",
- "name": "string",
- "parentId": 0,
- "orderIndex": 0
}
]
}Retrieve information on a specific permission.
| permissionId required | integer <int32> The permission id. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "id": 0,
- "uid": "string",
- "name": "string",
- "hierarchyPath": [
- "string"
], - "requiredAccessPolicies": [
- {
- "id": 0,
- "key": "string",
- "name": "string"
}
]
}Check if a role has sufficient access policies for the specified permissions.
| roleId required | integer <int32> Role id to check. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Permissions to check.
| permissionsUids | Array of strings <uuid> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "permissionsUids": [
- "string"
]
}{- "isSufficient": true,
- "missingAccessPolicies": [
- {
- "id": 0,
- "key": "string",
- "name": "string"
}
]
}| providerId required | integer <int32> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "ProviderId": 1,
- "ProviderTypeId": 1,
- "Name": "Idsrv",
- "DisplayName": "DFS.Identity",
- "IsEnabled": true,
- "IsDefault": true,
- "CreatedDate": "2025-07-31T10:46:55.1515465Z",
- "LastUpdatedDate": "2025-07-31T10:46:55.1515466Z"
}Retrieves a list of (B/O) menu items and functionality accessible by identities under an identity-role in a specific tenant.
| roleId required | integer <int32> The role id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DefaultMenuItemId": 2453,
- "MenuItemIds": [
- 27,
- 34
], - "FunctionalityIds": [
- 71,
- 72
]
}Sets a list of (B/O) menu items and functionality accessible by identities under an identity-role in a specific tenant.
| roleId required | integer <int32> The identity role ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The set identity tenant functionalities and menu items payload
| defaultMenuItemId | integer <int32> Nullable |
| menuItemIds | Array of integers <int32> Nullable |
| functionalityIds | Array of integers <int32> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DefaultMenuItemId": 2453,
- "MenuItemIds": [
- 27,
- 34,
- 2453
], - "FunctionalityIds": [
- 71,
- 72
]
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Retrieves a list of available (B/O) menu items and functionality.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "MenuItems": [
- {
- "Id": 11,
- "Name": "Dashboard",
- "Description": "",
- "PageLink": "/Dashboard/Index",
- "MenuTypeId": 1,
- "PermissionUid": "f4644f07-26fe-4d61-a4d8-147b0ccfd164"
}, - {
- "Id": 12,
- "Name": "Messages",
- "Description": "",
- "PageLink": "/",
- "MenuTypeId": 1,
- "PermissionUid": "0c3814b5-55bb-412d-a116-57ae8d4b2253"
}, - {
- "Id": 13,
- "ParentId": 12,
- "Name": "Inbox",
- "Description": "Inbox page",
- "PageLink": "/Messaging/Message/Inbox",
- "MenuTypeId": 1,
- "PermissionUid": "80fef640-c25b-466b-8744-ad405724041b"
}
], - "FunctionalityGroups": [
- {
- "Id": 20,
- "Name": "Contacts",
- "SortOrder": 1,
- "PermissionUid": "3d7441bf-5df7-42c1-9372-678d0787a5fe",
- "Functionalities": [
- {
- "Id": 101,
- "Name": "Enable Documents",
- "Key": "EnableDocuments",
- "SortOrder": 2,
- "PermissionUid": "a461dd13-74ec-4d63-be00-9e6c55590d4f"
}, - {
- "Id": 102,
- "Name": "Enable Profile Picture tab",
- "Key": "EnableProfilePictureTab",
- "SortOrder": 3,
- "PermissionUid": "85f086e1-ffc4-4986-bbfa-47fd11ff0de5"
}
]
}, - {
- "Id": 21,
- "Name": "Clients",
- "SortOrder": 2,
- "PermissionUid": "07ee90ed-8f7a-459b-a1fc-8b9b55b301ff",
- "Functionalities": [
- {
- "Id": 103,
- "Name": "Enable DataExportToCSV",
- "Key": "EnableDataExportToCSV",
- "SortOrder": 1,
- "PermissionUid": "8cd692fc-efc4-4746-8617-52c426bab0f4"
}
]
}
]
}This API is deprecated
Retrieves a list of (B/O) menu items and functionality accessible by specific identity in a specific tenant. Note that identity specific permissions override role permissions.
| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DefaultMenuItemId": 12,
- "MenuItemIds": [
- 11,
- 12,
- 13
], - "FunctionalityIds": [
- 101,
- 102,
- 103
]
}This API is deprecated
Sets a list of (B/O) menu items and functionality accessible by a specific identity in a specific tenant. Note that identity specific permissions override role permissions
| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The set identity tenant functionalities and menu items payload
| defaultMenuItemId | integer <int32> Nullable |
| menuItemIds | Array of integers <int32> Nullable |
| functionalityIds | Array of integers <int32> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DefaultMenuItemId": 11,
- "MenuItemIds": [
- 11,
- 12,
- 13
], - "FunctionalityIds": [
- 101,
- 103
]
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ImageContentBase64": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCABGADwDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD9PaKK5n4meO7D4Y+Ade8Vam5Sx0mzlu5MdTtUkAepJGB7mgDB+Mn7QXgP4CaINT8a+ILXSInz5ULEtNNjqEjUFm7dB3FfJF9/wWS+E1vqjQQeHPEt1aK237UkUKhh/eCmQHH1wa/LD43fGbxR+0V8TNQ8Sa5cTXl3eTMtpaKSyW8W47Io17ADA9zyeTXomk/8E9fj3rPhxdag8A3y2zJ5iwzMsc7LjPEZOfwoA/aD4D/tdfDL9oqFl8IeIIptQjTfLptyDDcIP91gMjPdcivZq/ma02/8W/BHx/DdRfb/AAz4n0e4ztcNDNDIvVWB59iD1Br+gH9kn48xftGfA3QPGBEcWozIYL+CI/LHcJgOB7ZII9iKAPZKKKKACvkT/gp18UPD3g/9mPxDoF/q0VtrWurHBY2StmWbbIrMdo5CgA5Y8dB1Ir67r83v2lP+CY/xD+P/AMW9b8W3XxHs57S6lzZ214kn+iw4+WJVGVAHt1JJPJNAHzv/AMEjvhbovjv4+6jrOsRQXZ8P2BubW3mAP75nVVkAP90bvoSK/Qr4hf8ABQn4Y/DP45Q/C3VF1A6r58VrNewwg21vLJt2Ixzn+JckAgZ+teEfstf8E9PiD+yv8XNO8V2njfQryKVWtLrT3EiG5hYgsqnb975QR/u19HeOv2EfhX8RPjNb/EzWNMuJNfSWK4kijnKwTyx42M6d8bV9jjmgD5C/4LL/AAv0K30nwb49s7WO31m5uG0+5ljGPPj2F0LepXaQD6H2FUP+CLfxFnXU/HfgmWZmtmjh1K3iJ4V8lJCB7jy8/wC6K2/+C1Him3h8O/DvwyjAzyXE98VHVVRQgz9d5/I186f8EmPEg0P9rSytGk2/2ppd1bBf7xCiT/2maAP3EooooAK8a/ah/ag8Lfsv+AZde12QXF/MDHp+lxuBLdSY6DrhR3bGB+VekeO/G2k/Dnwfq3ibXLlbPSdLt3ubiZudqKMnA7n271/Pb+1V+0drf7S/xW1HxLqUskenKxh02xLfJbW4J2qB0yepPcn6UAfoP/wT1+Jvjb9rT9oXxT8S/GV+0un+HrQ2mm6ZGCtvavcNkbBnqEiYEnk5FfpQWCgknAFfnB/wRXWH/hWPxAI2+f8A2pAG9dvltj+tfSv7dX7SVv8As3/A3VNShkU+IdURrDS4d2G811wZPogO76gDvQB+UP8AwUq+MUPxd/ae1v7DOJ9M0FF0m3dTlSY8+Zj/ALaF/wAqx/8AgnVqyaP+2F8P5nbaJJ5YPxkhdAP/AB6vnK8u5b67muZ3Mk0ztI7N1LE5Jr0f9mbxMng/9oD4fatI2yK31u0Z2zgBTKoJ/KgD+kaimW8gmt45ByGUMPxFPoA4P45/COw+Onwt17wRqd1PY2erQ+U1xbkb4znIIz15HSvy/wD21f8Agnr4e/Zt/ZxtNa8LpeeINXh1VG1TVrj70duUZQFQcKm8pnqcnrjp+vlfnD/wVC/bUk8E2t78IfC0cc2qXttt1i8kQP8AZ43GREoIxuZSCT2DDHJyAD5//wCCR/x1tvh78ZNR8FancLBYeKokWBpGwBdRk+WvP94O49ztr62/bs/YT8c/tYfEnQdV0rxRp+m+H7CzFv8AZbwOWicuS7qo4ORt7j7or8YNNvb3SNQt76zkltru3cSRTRZVkYHIIPY5r9gf2Jf+CmWh+PdH0/wh8ULyPRPE8KrBDrE42W99gYBduiSeucKc9ulAHiP7QH/BKe3+D37Per+KNH1u98TeKtLK3NxGsQjhNuMiTYgycjIbJbop4r85IZntp0kQ7XRgw9iK/qFkjs9c02SNvKvLK5jKsOHR1I6ehBFfi5+37/wT/wBZ+C/ibUfGfgnTZNQ8BXjmZ4LZSz6YxPKMOvl8jDduh6AkA/Vj9lr4oRfGL4B+DPFCSrLNd2CJcFT0mT93J/48jV6rX5Q/8Egf2jItF1bV/hNrd0YkvnN7pAlPHmgDzIh6ZUbsezdzX6vUAFcT4m+CfgHxlq0mp654P0XVdQkAD3V5YRSyNgYGWZSTxRRQBlf8M0/Cr/onvhv/AMFcP/xNKP2avhWpBHw+8Ng/9guH/wCJoooA7vQ9A07wzp0VhpdnDYWUQxHb26BEQegA4FWrq0hvreSC4iSeGRSrxyKCrA9QQaKKAPDv+GIvg7D8SNO8dWPhOLSfEdjOLmKfTZXt4/MGeTGhCnr6c17tRRQB/9k=",
- "IsDefaultImage": false
}| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The picture represented as base64 string
| imageContentBase64 | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ImageContentBase64": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCABGADwDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD9PaKK5n4meO7D4Y+Ade8Vam5Sx0mzlu5MdTtUkAepJGB7mgDB+Mn7QXgP4CaINT8a+ILXSInz5ULEtNNjqEjUFm7dB3FfJF9/wWS+E1vqjQQeHPEt1aK237UkUKhh/eCmQHH1wa/LD43fGbxR+0V8TNQ8Sa5cTXl3eTMtpaKSyW8W47Io17ADA9zyeTXomk/8E9fj3rPhxdag8A3y2zJ5iwzMsc7LjPEZOfwoA/aD4D/tdfDL9oqFl8IeIIptQjTfLptyDDcIP91gMjPdcivZq/ma02/8W/BHx/DdRfb/AAz4n0e4ztcNDNDIvVWB59iD1Br+gH9kn48xftGfA3QPGBEcWozIYL+CI/LHcJgOB7ZII9iKAPZKKKKACvkT/gp18UPD3g/9mPxDoF/q0VtrWurHBY2StmWbbIrMdo5CgA5Y8dB1Ir67r83v2lP+CY/xD+P/AMW9b8W3XxHs57S6lzZ214kn+iw4+WJVGVAHt1JJPJNAHzv/AMEjvhbovjv4+6jrOsRQXZ8P2BubW3mAP75nVVkAP90bvoSK/Qr4hf8ABQn4Y/DP45Q/C3VF1A6r58VrNewwg21vLJt2Ixzn+JckAgZ+teEfstf8E9PiD+yv8XNO8V2njfQryKVWtLrT3EiG5hYgsqnb975QR/u19HeOv2EfhX8RPjNb/EzWNMuJNfSWK4kijnKwTyx42M6d8bV9jjmgD5C/4LL/AAv0K30nwb49s7WO31m5uG0+5ljGPPj2F0LepXaQD6H2FUP+CLfxFnXU/HfgmWZmtmjh1K3iJ4V8lJCB7jy8/wC6K2/+C1Him3h8O/DvwyjAzyXE98VHVVRQgz9d5/I186f8EmPEg0P9rSytGk2/2ppd1bBf7xCiT/2maAP3EooooAK8a/ah/ag8Lfsv+AZde12QXF/MDHp+lxuBLdSY6DrhR3bGB+VekeO/G2k/Dnwfq3ibXLlbPSdLt3ubiZudqKMnA7n271/Pb+1V+0drf7S/xW1HxLqUskenKxh02xLfJbW4J2qB0yepPcn6UAfoP/wT1+Jvjb9rT9oXxT8S/GV+0un+HrQ2mm6ZGCtvavcNkbBnqEiYEnk5FfpQWCgknAFfnB/wRXWH/hWPxAI2+f8A2pAG9dvltj+tfSv7dX7SVv8As3/A3VNShkU+IdURrDS4d2G811wZPogO76gDvQB+UP8AwUq+MUPxd/ae1v7DOJ9M0FF0m3dTlSY8+Zj/ALaF/wAqx/8AgnVqyaP+2F8P5nbaJJ5YPxkhdAP/AB6vnK8u5b67muZ3Mk0ztI7N1LE5Jr0f9mbxMng/9oD4fatI2yK31u0Z2zgBTKoJ/KgD+kaimW8gmt45ByGUMPxFPoA4P45/COw+Onwt17wRqd1PY2erQ+U1xbkb4znIIz15HSvy/wD21f8Agnr4e/Zt/ZxtNa8LpeeINXh1VG1TVrj70duUZQFQcKm8pnqcnrjp+vlfnD/wVC/bUk8E2t78IfC0cc2qXttt1i8kQP8AZ43GREoIxuZSCT2DDHJyAD5//wCCR/x1tvh78ZNR8FancLBYeKokWBpGwBdRk+WvP94O49ztr62/bs/YT8c/tYfEnQdV0rxRp+m+H7CzFv8AZbwOWicuS7qo4ORt7j7or8YNNvb3SNQt76zkltru3cSRTRZVkYHIIPY5r9gf2Jf+CmWh+PdH0/wh8ULyPRPE8KrBDrE42W99gYBduiSeucKc9ulAHiP7QH/BKe3+D37Per+KNH1u98TeKtLK3NxGsQjhNuMiTYgycjIbJbop4r85IZntp0kQ7XRgw9iK/qFkjs9c02SNvKvLK5jKsOHR1I6ehBFfi5+37/wT/wBZ+C/ibUfGfgnTZNQ8BXjmZ4LZSz6YxPKMOvl8jDduh6AkA/Vj9lr4oRfGL4B+DPFCSrLNd2CJcFT0mT93J/48jV6rX5Q/8Egf2jItF1bV/hNrd0YkvnN7pAlPHmgDzIh6ZUbsezdzX6vUAFcT4m+CfgHxlq0mp654P0XVdQkAD3V5YRSyNgYGWZSTxRRQBlf8M0/Cr/onvhv/AMFcP/xNKP2avhWpBHw+8Ng/9guH/wCJoooA7vQ9A07wzp0VhpdnDYWUQxHb26BEQegA4FWrq0hvreSC4iSeGRSrxyKCrA9QQaKKAPDv+GIvg7D8SNO8dWPhOLSfEdjOLmKfTZXt4/MGeTGhCnr6c17tRRQB/9k="
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "MemberId": 1,
- "IdentityId": "01000000-0000-0000-0000-000000000000",
- "UserName": "additiv",
- "FirstName": "Admin",
- "LastName": "Admin",
- "SalutationId": 2,
- "Email": "admin@additiv.com",
- "Description": "Admin account description",
- "Phone": "41|522672742",
- "Mobile": "41|797353960",
- "IdentityProviderSettingId": 1,
- "ExternalId": "EX001245",
- "IdentityRole": {
- "Id": 1,
- "Name": "System-Administrator"
}, - "IdentityProvider": {
- "Id": 1,
- "Name": "DFS.Identity"
}, - "BankBranch": {
- "Id": 1,
- "Name": "<root><en>Branch 1a</en></root>"
}, - "IsSignInEnabled": true,
- "IsTenantAccessEnabled": true,
- "AssignedContactsCount": 2,
- "ParticipantIds": [
- 1
]
}| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "accessPolicies": [
- {
- "id": 0,
- "key": "string",
- "name": "string"
}
]
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Identity": {
- "IdentityId": "01000000-0000-0000-0000-000000000000",
- "MemberId": 1,
- "FirstName": "Admin",
- "LastName": "Admin"
}, - "Role": {
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 6
}
}, - {
- "Identity": {
- "IdentityId": "06000000-0000-0000-0000-000000000000",
- "MemberId": 6,
- "FirstName": "Team",
- "LastName": "Leader 1"
}, - "Role": {
- "Id": 43,
- "Name": "Team Leader",
- "HierarchyLevel": 4
}
}
]| identityId required | string <uuid> The Internal ID of an identity of the Base element of the Member Role Hierarchy |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Superiors": [
- {
- "Identity": {
- "IdentityId": "11655f64-5717-4562-b3fc-2cab3f66af00",
- "MemberId": 55,
- "FirstName": "Jack",
- "LastName": "Daniels"
}, - "Role": {
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 6
}
}, - {
- "Identity": {
- "IdentityId": "11655f64-5717-4562-b3fc-2cab3f66bb77",
- "MemberId": 55,
- "FirstName": "Captain",
- "LastName": "Morgan"
}, - "Role": {
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 6
}
}
], - "Base": {
- "Identity": {
- "IdentityId": "01000000-0000-0000-0000-000000000000",
- "MemberId": 1,
- "FirstName": "Admin",
- "LastName": "Admin"
}, - "Role": {
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 6
}
}, - "HierarchyItems": [
- {
- "Identity": {
- "IdentityId": "06000000-0000-0000-0000-000000000000",
- "MemberId": 6,
- "FirstName": "Team",
- "LastName": "Leader 1"
}, - "Role": {
- "Id": 43,
- "Name": "Team Leader",
- "HierarchyLevel": 4
}
}, - {
- "Identity": {
- "IdentityId": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
- "MemberId": 16,
- "FirstName": "Bill",
- "LastName": "Doe"
}, - "Role": {
- "Id": 2,
- "Name": "General Manager",
- "HierarchyLevel": 2
}
}
]
}| identityId required | string <uuid> The Identity ID of the user that is trying to access Person ID |
| personId required | integer <int32> The accessed Person ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
true| identityId required | string <uuid> The Identity ID of the user that is trying to access Person ID |
| personUId required | string <uuid> The accessed Person unique ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
true| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The update identity payload
| updateProperties | Array of strings Nullable |
| firstName | string Nullable |
| lastName | string Nullable |
| salutationId | integer <int32> Nullable |
string Nullable | |
| description | string Nullable |
| phone | string Nullable |
| mobile | string Nullable |
| url | string Nullable |
| bankBranchId | integer <int32> Nullable |
| identityRoleId | integer <int32> |
| externalId | string Nullable |
| userName | string Nullable |
| resetPassword | object (ResetPasswordRequest) |
| changePassword | object (ChangePasswordRequest) |
| isSignInEnabled | boolean |
| isTenantAccessEnabled | boolean |
| participantIds | Array of integers <int32> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "FirstName": "Sarah",
- "LastName": "Connor",
- "SalutationId": 1,
- "Email": "sconnor@additiv.com",
- "Description": "Sarah Connor account description",
- "Phone": "41|9379992",
- "Mobile": "41|0480003",
- "BankBranchId": 2,
- "IdentityRoleId": 1,
- "ExternalId": "0001EXT-F",
- "UserName": "sconn",
- "ResetPassword": {
- "Password": "Test@1234",
- "ConfirmPassword": "Test@1234"
}, - "ChangePassword": {
- "OldPassword": "superseretPassword.123",
- "Password": "Test@1234",
- "ConfirmPassword": "Test@1234"
}, - "IsSignInEnabled": true,
- "IsTenantAccessEnabled": true,
- "ParticipantIds": [
- 1
], - "UpdateProperties": [
- "FirstName",
- "LastName",
- "SalutationId",
- "Email",
- "Description",
- "Phone",
- "Mobile",
- "Url",
- "BankBranchId",
- "IdentityRoleId",
- "ExternalId",
- "UserName",
- "IsSignInEnabled",
- "IsTenantAccessEnabled",
- "ParticipantIds",
- "ResetPassword",
- "ChangePassword"
]
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| tenantId required | integer <int32> The Tenant ID |
| identityId required | string <uuid> The Internal User ID of an identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The set identity tenant access payload
| tenantId | integer <int32> |
| identityRoleId | integer <int32> Nullable |
| isEnabled | boolean |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "TenantId": 12,
- "IdentityRoleId": 1,
- "IsEnabled": true
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search criteria
| page | integer <int32> |
| pageSize | integer <int32> |
| sortBy | string Nullable |
| sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
| roleIds | Array of integers <int32> Nullable |
| identityIds | Array of strings <uuid> Nullable |
| participantIds | Array of integers <int32> Nullable |
| firstName | string Nullable |
| lastName | string Nullable |
| searchTerm | string Nullable |
| searchIdentityBy | string (SearchIdentityBy) Enum: "FirstName" "LastName" "UserName" "Email" "IdentityProviderName" "RoleName" "FullName" "All" |
| searchByAllTenants | boolean |
| searchByInactive | boolean |
| searchBySystemAccounts | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RoleIds": [
- 1,
- 3
], - "IdentityIds": [
- "01000000-0000-0000-0000-000000000000"
], - "ParticipantIds": [
- 1,
- 7
], - "FirstName": "Admin",
- "LastName": "Admin",
- "SearchTerm": "ad",
- "SearchIdentityBy": "All",
- "SearchByAllTenants": true,
- "SearchByInactive": true,
- "SearchBySystemAccounts": false,
- "SortBy": "LastName",
- "SortOrder": "Descending",
- "Page": 1,
- "PageSize": 10
}{- "Results": [
- {
- "IdentityId": "01000000-0000-0000-0000-000000000000",
- "ParticipantIds": [
- 12
], - "FirstName": "Admin",
- "LastName": "Admin",
- "Email": "admin@additiv.com",
- "Description": "Admin account description",
- "UserName": "additiv",
- "IdentityRole": {
- "Id": 1,
- "Name": "System-Administrator"
}, - "IsSignInEnabled": true,
- "IsTenantAccessEnabled": true,
- "AssignedContactsCount": 2,
- "IdentityProvider": {
- "Id": 1,
- "Name": "DFS.Identity"
}, - "MemberId": 1,
- "BankBranch": {
- "Id": 1,
- "Name": "<root><en>Branch 1a</en></root>"
}
}, - {
- "IdentityId": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
- "ParticipantIds": [
- 14
], - "FirstName": "Bill",
- "LastName": "Doe",
- "Email": "bd@additiv.com",
- "Description": "Bill account description",
- "UserName": "bdou",
- "IdentityRole": {
- "Id": 2,
- "Name": "General Manager"
}, - "IsSignInEnabled": true,
- "IsTenantAccessEnabled": true,
- "AssignedContactsCount": 2,
- "IdentityProvider": {
- "Id": 1,
- "Name": "DFS.Identity"
}, - "MemberId": 1,
- "BankBranch": {
- "Id": 3,
- "Name": "<root><en>BD Local Branch</en></root>"
}
}
], - "Page": 1,
- "PageSize": 10,
- "PageCount": 1,
- "TotalCount": 2
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The create/add identity payload
| firstName | string Nullable |
| lastName | string Nullable |
| salutationId | integer <int32> Nullable |
string Nullable | |
| description | string Nullable |
| phone | string Nullable |
| mobile | string Nullable |
| url | string Nullable |
| bankBranchId | integer <int32> Nullable |
| identityRoleId | integer <int32> |
| externalId | string Nullable |
| username | string Nullable |
| password | string Nullable |
| participantIds | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "FirstName": "John",
- "LastName": "Connor",
- "SalutationId": 2,
- "Email": "jct@additiv.com",
- "Description": "John Connor account description",
- "Phone": "41|522672742",
- "Mobile": "41|633783853",
- "BankBranchId": 1,
- "IdentityRoleId": 1,
- "ExternalId": "EX006D34-9",
- "Username": "jconnor",
- "Password": "superseretPassword.123",
- "ParticipantIds": [
- 1
]
}{- "IdentityId": "3aaa5f64-5717-4562-b3fc-2c963f66af11"
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "longRunningRequestId": "string"
}| identityId required | string <uuid> The Internal User ID of an Identity |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The list of restricted sub-users
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- "string"
]{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Retrieve details of a participant
| participantId required | integer <int32> The ID of the participant |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "uid": "string",
- "isActive": true
}Updates a participant
| participantId required | integer <int32> The ID of the participant |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request body
| name | string Nullable |
| isActive | boolean |
| identityInternalUserIds | Array of strings <uuid> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "isActive": true,
- "identityInternalUserIds": [
- "string"
]
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Retrieves information on participants
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "results": [
- {
- "id": 0,
- "uid": "string",
- "name": "string",
- "isActive": true,
- "settingsUrl": "string"
}
]
}Creates a participant
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request body
| name | string Nullable |
| identityInternalUserIds | Array of strings <uuid> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "identityInternalUserIds": [
- "string"
]
}{- "Id": 1,
- "UId": "9049589d-234b-4d0a-b3ad-429e7d0c4822"
}Searches participants
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search criteria
| page | integer <int32> |
| pageSize | integer <int32> |
| sortBy | string Nullable |
| sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
| name | string Nullable |
| participantIds | Array of integers <int32> Nullable |
| isActive | boolean Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "name": "string",
- "participantIds": [
- 0
], - "isActive": true
}{- "results": [
- {
- "id": 0,
- "uid": "string",
- "name": "string",
- "isActive": true
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}Associate one or more participants with an application
| applicationId required | string The application identifier |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request body that contains the collection of participants to be added
| participantIds | Array of integers <int32> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "participantIds": [
- 0
]
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| roleId required | integer <int32> The ID of the role to delete |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Retrieves information on a specific role
| roleId required | integer <int32> The ID of the role to update |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ShortName": "role",
- "LongName": "role",
- "RoleKey": "role",
- "CreatedDate": "2025-07-31T10:46:55.1912693Z",
- "AllowAllPolicies": false,
- "AccessPolicies": [
- {
- "Id": 1,
- "Name": "AccessPolicy",
- "Key": "AccessPolicy"
}
]
}Updates role information and access policy configuration for the role. Specify AccessPolicyIds only if AllowAllPolicies is set to false. 2 Setting AllowAllPolicies to true will remove the current list of access policies assigned to the role.
| roleId required | integer <int32> The ID of the role to update |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| shortName | string Nullable |
| longName | string Nullable |
| roleKey | string Nullable |
| allowAllPolicies | boolean Nullable |
| accessPolicyIds | Array of integers <int32> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ShortName": "System-Administrator",
- "LongName": "System-Administrator",
- "RoleKey": "admin",
- "AllowAllPolicies": true,
- "AccessPolicyIds": [
- 1
]
}{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 6,
- "RoleKey": "System-Administrator"
}, - {
- "Id": 35,
- "Name": "Relationship Manager",
- "HierarchyLevel": 5,
- "RoleKey": "rm"
}, - {
- "Id": 43,
- "Name": "Team Leader",
- "HierarchyLevel": 4,
- "RoleKey": "tm"
}
]| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| shortName | string Nullable |
| longName | string Nullable |
| roleKey | string Nullable |
| isMemberAccessExcluded | boolean Nullable Set to 1 if members created or moved to this role should not have access to any other member (regardless of hierarchy level) unless manually specified. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ShortName": "System-Administrator",
- "LongName": "System-Administrator",
- "RoleKey": "admin",
- "IsMemberAccessExcluded": true
}{- "Id": 1,
- "TenantId": 2,
- "ShortName": "System-Administrator",
- "LongName": "System-Administrator",
- "RoleKey": "admin",
- "CreatedDate": "2025-07-31T10:46:55.255766Z"
}| roleId required | integer <int32> The role ID of Base element of the Role Hierarchy |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Base": {
- "Id": 1,
- "Name": "System-Administrator",
- "HierarchyLevel": 6
}, - "HierarchyItems": [
- {
- "Id": 58,
- "Name": "Air Force Major",
- "HierarchyLevel": 7
}, - {
- "Id": 57,
- "Name": "Air Force Major",
- "HierarchyLevel": 8
}, - {
- "Id": 59,
- "Name": "Air Force Major",
- "HierarchyLevel": 8
}
]
}| roleId required | integer <int32> The role ID |
| operation required | string (RoleHierarchyRankOperation) Enum: "Up" "Down" The role hierarchy rank change operation (up or down) |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Set the role hierarchy restrictions (forbidden sub-role(s) access) for specified Role ID
| roleId required | integer <int32> The Role ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The list of role IDs to exclude from the hierarchy
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- 0
]{- "Code": "BadRequest",
- "SubCode": "NA",
- "Message": "The request was not in the required format",
- "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}