DFS Admin Services API (latest)

Download OpenAPI specification:Download

Administration Services

AccessPolicyManagement

Access-Policies Management API

Access policies

Retrieves all the access policies associated to the client apps in the context of a specified api resource and api scope.

Authorizations:

Bearer

path Parameters

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.

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/tenants/{tenantUid}/resources/{apiResource}/scopes/{apiScope}/access-policies

https://example-host/v1.0/tenants/{tenantUid}/resources/{apiResource}/scopes/{apiScope}/access-policies

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Result": "success",
"AccessPolicies": 
{"zy4I5dHA5tjMkgaeZBNmQShGpzP8vo": 
["RMember",
"WMember"
],
"dMJ8UyS8KCgsyKNC35bPYfjuZmuqFL": 
["RRole",
"WRole"
]
}
}

Identity roles with authorization access policies

Retrieves all the identity roles with theirs associates authorization access policies in the context of a specified tenant.

Authorizations:

Bearer

path Parameters

tenantUid

required

string <uuid>

The tenant identifier that identity roles belong to.

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/tenants/{tenantUid}/identity-roles

https://example-host/v1.0/tenants/{tenantUid}/identity-roles

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}
]
}

Retrieve a list of API access policies.

Retrieves a list of API access policies.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/access-policies

https://example-host/v1.0/access-policies

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"accessPolicies": 
[
{"id": 0,
"key": "string",
"name": "string"
}
]
}

Retrieve a specific access policy.

Authorizations:

Bearer

path Parameters

accessPolicyId

required

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/access-policies/{accessPolicyId}

https://example-host/v1.0/access-policies/{accessPolicyId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/permissions

https://example-host/v1.0/permissions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"uid": "string",
"name": "string",
"parentId": 0,
"orderIndex": 0
}
]
}

Retrieve information on a specific permission.

Authorizations:

Bearer

path Parameters

permissionId

required

integer <int32>

The permission id.

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/permissions/{permissionId}

https://example-host/v1.0/permissions/{permissionId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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.

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

Role id to check.

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Permissions to check.

permissionsUids

Array of strings <uuid> Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/roles/{roleId}/required-access-policies/check

https://example-host/v1.0/roles/{roleId}/required-access-policies/check

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"permissionsUids": 
["string"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"isSufficient": true,
"missingAccessPolicies": 
[
{"id": 0,
"key": "string",
"name": "string"
}
]
}

AuditContext

Audit Context API

Generate an audit context

Generates a new audit context identifier which tracks the changes from database for a specific tenant. It serves as key when editing or adding records in tenant database. The tenant identifier is retrieved from Bearer Jwt.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The audit context request containing the list of the persons (either person ids, either internal user ids) involved in changes under audit, the app name creating the audit context (e.g. backoffice, services, migrating) and the authorized appId. The list of persons can be null if no person is involved in changes, e.g. registering contact.

createdby	string Nullable
authorizedAppId	string Nullable
personIds	Array of integers <int32> Nullable
internalIds	Array of strings <uuid> Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v3.0/audit-context/generate

https://example-host/v3.0/audit-context/generate

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"Createdby": "BackOffice",
"AuthorizedAppId": "jGER285mdgZuDq50PadB1ITWv3tM9Y",
"PersonIds": 
[1,
2,
4
],
"InternalIds": 
["01000000-0000-0000-0000-000000000000",
"b9533634-196e-4843-9c27-e9d391a15fc3"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"AuditContextId": 1001,
"TenantId": 2,
"TenantKey": "Additiv",
"TenantUid": "9a914b9b-425c-4faf-9347-ee990071c3f0",
"MemberIds": 
[1,
1002
]
}

BackOfficeManagement

Back-Office Management API

Get a identity provider setting by provider id

Authorizations:

Bearer

path Parameters

providerId

required

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/provider-setting/{providerId}

https://example-host/v1.0/identities/provider-setting/{providerId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Id": 1,
"ProviderId": 1,
"ProviderTypeId": 1,
"Name": "Idsrv",
"DisplayName": "DFS.Identity",
"IsEnabled": true,
"IsDefault": true,
"CreatedDate": "2024-11-05T14:58:54.4207752Z",
"LastUpdatedDate": "2024-11-05T14:58:54.4207753Z"
}

Retrieve a list of accessible (B/O) menu items and functionality.

Retrieves a list of (B/O) menu items and functionality accessible by identities under an identity-role in a specific tenant.

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The role id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/roles/{roleId}/back-office-permissions

https://example-host/v1.0/roles/{roleId}/back-office-permissions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"DefaultMenuItemId": 2453,
"MenuItemIds": 
[27,
34
],
"FunctionalityIds": 
[71,
72
]
}

Set a list of accessible (B/O) menu items and functionality.

Sets a list of (B/O) menu items and functionality accessible by identities under an identity-role in a specific tenant.

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The identity role ID

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/roles/{roleId}/back-office-permissions

https://example-host/v1.0/roles/{roleId}/back-office-permissions

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"DefaultMenuItemId": 2453,
"MenuItemIds": 
[27,
34,
2453
],
"FunctionalityIds": 
[71,
72
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Retrieve a list of available (B/O) menu items and functionality.

Retrieves a list of available (B/O) menu items and functionality.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/back-office-permissions

https://example-host/v1.0/back-office-permissions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"MenuItems": 
[
{"Id": 11,
"Name": "Dashboard",
"Description": "",
"PageLink": "/Dashboard/Index",
"MenuTypeId": 1,
"PermissionUid": "10da4440-cff4-47b5-9f94-986497e8e747"
},
{"Id": 12,
"Name": "Messages",
"Description": "",
"PageLink": "/",
"MenuTypeId": 1,
"PermissionUid": "8f8b9c60-f89f-4240-9c2b-844b076acd7b"
},
{"Id": 13,
"ParentId": 12,
"Name": "Inbox",
"Description": "Inbox page",
"PageLink": "/Messaging/Message/Inbox",
"MenuTypeId": 1,
"PermissionUid": "b5cf2a08-fc74-494f-898f-9c3684956248"
}
],
"FunctionalityGroups": 
[
{"Id": 20,
"Name": "Contacts",
"SortOrder": 1,
"PermissionUid": "43814448-9804-4251-bc40-f9420c170923",
"Functionalities": 
[
{"Id": 101,
"Name": "Enable Documents",
"Key": "EnableDocuments",
"SortOrder": 2,
"PermissionUid": "4a372d87-501a-45ba-8e0b-bb5dd243b428"
},
{"Id": 102,
"Name": "Enable Profile Picture tab",
"Key": "EnableProfilePictureTab",
"SortOrder": 3,
"PermissionUid": "65aa001c-89a7-41ad-8dfa-60d828414e79"
}
]
},
{"Id": 21,
"Name": "Clients",
"SortOrder": 2,
"PermissionUid": "3f919c96-02c8-407d-bae7-2e356ce35aee",
"Functionalities": 
[
{"Id": 103,
"Name": "Enable DataExportToCSV",
"Key": "EnableDataExportToCSV",
"SortOrder": 1,
"PermissionUid": "e24818a1-fc0c-4398-a0a7-3e4cc62fef37"
}
]
}
]
}

Retrieve a list of accessible (B/O) menu items and functionality Deprecated

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.

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/{identityId}/back-office-permissions

https://example-host/v1.0/identities/{identityId}/back-office-permissions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"DefaultMenuItemId": 12,
"MenuItemIds": 
[11,
12,
13
],
"FunctionalityIds": 
[101,
102,
103
]
}

Set a list of accessible (B/O) menu items and functionality Deprecated

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

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/identities/{identityId}/back-office-permissions

https://example-host/v1.0/identities/{identityId}/back-office-permissions

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"DefaultMenuItemId": 11,
"MenuItemIds": 
[11,
12,
13
],
"FunctionalityIds": 
[101,
103
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

IdentityManagement

Identity Management API

Delete identity picture

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/identities/{identityId}/profilepicture

https://example-host/v1.0/identities/{identityId}/profilepicture

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get identity picture

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/{identityId}/profilepicture

https://example-host/v1.0/identities/{identityId}/profilepicture

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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
}

Upload identity picture

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The picture represented as base64 string

imageContentBase64

string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

put/v1.0/identities/{identityId}/profilepicture

https://example-host/v1.0/identities/{identityId}/profilepicture

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"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="
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get the identity by Internal User ID

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/{identityId}

https://example-host/v1.0/identities/{identityId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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",
"Url": "https://admin.additiv.com",
"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
]
}

Get all the identities and their roles (including hierarchy level)

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/identities/roles/hierarchy-level

https://example-host/v1.0/identities/roles/hierarchy-level

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"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
}
}
]

Get member-role hierarchy by Internal ID

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal ID of an identity of the Base element of the Member Role Hierarchy

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/{identityId}/hierarchy

https://example-host/v1.0/identities/{identityId}/hierarchy

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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
}
}
]
}

Validate whether an identity has access to a contact, member or legal entity (defined by personId)

Authorizations:

Bearer

path Parameters

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

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/{identityId}/hierarchy/{personId}/exists

https://example-host/v1.0/identities/{identityId}/hierarchy/{personId}/exists

Response samples

Content type

application/json

Copy

Expand all Collapse all

true

Validate whether an identity has access to a contact, member or legal entity (defined by personId)

Authorizations:

Bearer

path Parameters

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

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/identities/{identityId}/hierarchy/personuid/{personUId}/exists

https://example-host/v1.0/identities/{identityId}/hierarchy/personuid/{personUId}/exists

Response samples

Content type

application/json

Copy

Expand all Collapse all

true

Update the identity with specified Internal User ID

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The update identity payload

updateProperties	Array of strings Nullable
firstName	string Nullable
lastName	string Nullable
salutationId	integer <int32> Nullable
email	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

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.3/identities/{identityId}

https://example-host/v1.3/identities/{identityId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"FirstName": "Sarah",
"LastName": "Connor",
"SalutationId": 1,
"Email": "sconnor@additiv.com",
"Description": "Sarah Connor account description",
"Phone": "41|9379992",
"Mobile": "41|0480003",
"Url": "https://sc.additiv.com",
"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",
"Email",
"Description",
"Phone",
"Mobile",
"Url",
"BankBranchId",
"IdentityRoleId",
"ExternalId",
"UserName",
"IsSignInEnabled",
"IsTenantAccessEnabled",
"ParticipantIds",
"ResetPassword",
"ChangePassword"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Set the access to the tenant (including role)

Authorizations:

Bearer

path Parameters

tenantId required	integer <int32> The Tenant ID
identityId required	string <uuid> The Internal User ID of an identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The set identity tenant access payload

tenantId	integer <int32>
identityRoleId	integer <int32> Nullable
isEnabled	boolean

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/tenants/{tenantId}/identities/{identityId}/access

https://example-host/v1.0/tenants/{tenantId}/identities/{identityId}/access

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"TenantId": 12,
"IdentityRoleId": 1,
"IsEnabled": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Search the identities by given search criteria.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/identities/search

https://example-host/v1.0/identities/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"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
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Results": 
[
{"IdentityId": "01000000-0000-0000-0000-000000000000",
"ParticipantIds": 
[12
],
"FirstName": "Admin",
"LastName": "Admin",
"Email": "admin@additiv.com",
"Url": "https://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",
"Url": "https://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
}

Create a new identity

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The create/add identity payload

firstName	string Nullable
lastName	string Nullable
salutationId	integer <int32> Nullable
email	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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.2/identities

https://example-host/v1.2/identities

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"FirstName": "John",
"LastName": "Connor",
"SalutationId": 2,
"Email": "jct@additiv.com",
"Description": "John Connor account description",
"Phone": "41|522672742",
"Mobile": "41|633783853",
"Url": "https://jc.additiv.com",
"BankBranchId": 1,
"IdentityRoleId": 1,
"ExternalId": "EX006D34-9",
"Username": "jconnor",
"Password": "superseretPassword.123",
"ParticipantIds": 
[1
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"IdentityId": "3aaa5f64-5717-4562-b3fc-2c963f66af11"
}

Import member data into the tenant database.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1.0/identities/import-members

https://example-host/v1.0/identities/import-members

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"longRunningRequestId": "string"
}

Exclude the identities from identity hierarchy

Authorizations:

Bearer

path Parameters

identityId

required

string <uuid>

The Internal User ID of an Identity

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The list of restricted sub-users

Array

string <uuid>

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

put/v1.0/identities/{identityId}/hierarchy/exclude

https://example-host/v1.0/identities/{identityId}/hierarchy/exclude

Request samples

Payload

Content type

Copy

Expand all Collapse all


["string"
]

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

RoleManagement

Role Management API

Delete role

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The ID of the role to delete

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v2.0/roles/{roleId}

https://example-host/v2.0/roles/{roleId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Retrieve information on a specific role

Retrieves information on a specific role

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The ID of the role to update

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v2.0/roles/{roleId}

https://example-host/v2.0/roles/{roleId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ShortName": "role",
"LongName": "role",
"RoleKey": "role",
"CreatedDate": "2024-11-05T14:58:54.4456248Z",
"AllowAllPolicies": false,
"AccessPolicies": 
[
{"Id": 1,
"Name": "AccessPolicy",
"Key": "AccessPolicy"
}
]
}

Update role

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.

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The ID of the role to update

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The parameter DTO

shortName	string Nullable
longName	string Nullable
roleKey	string Nullable
allowAllPolicies	boolean Nullable
accessPolicyIds	Array of integers <int32> Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v2.0/roles/{roleId}

https://example-host/v2.0/roles/{roleId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"ShortName": "System-Administrator",
"LongName": "System-Administrator",
"RoleKey": "admin",
"AllowAllPolicies": true,
"AccessPolicyIds": 
[1
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get all roles

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v2.0/roles

https://example-host/v2.0/roles

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"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"
}
]

Create role

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/roles

https://example-host/v2.0/roles

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"ShortName": "System-Administrator",
"LongName": "System-Administrator",
"RoleKey": "admin",
"IsMemberAccessExcluded": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Id": 1,
"TenantId": 2,
"ShortName": "System-Administrator",
"LongName": "System-Administrator",
"RoleKey": "admin",
"CreatedDate": "2024-11-05T14:58:54.5006959Z"
}

Get role hierarchy by Role ID

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The role ID of Base element of the Role Hierarchy

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v2.0/roles/{roleId}/hierarchy

https://example-host/v2.0/roles/{roleId}/hierarchy

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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
}
]
}

Change the hierarchy level of specified role

Authorizations:

Bearer

path Parameters

roleId required	integer <int32> The role ID
operation required	string (RoleHierarchyRankOperation) Enum: "Up" "Down" The role hierarchy rank change operation (up or down)

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v2.0/roles/{roleId}/hierarchy-level/{operation}

https://example-host/v2.0/roles/{roleId}/hierarchy-level/{operation}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Set the role hierarchy restrictions

Set the role hierarchy restrictions (forbidden sub-role(s) access) for specified Role ID

Authorizations:

Bearer

path Parameters

roleId

required

integer <int32>

The Role ID

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The list of role IDs to exclude from the hierarchy

Array

integer <int32>

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

put/v2.0/roles/{roleId}/hierarchy/exclude

https://example-host/v2.0/roles/{roleId}/hierarchy/exclude

Request samples

Payload

Content type

Copy

Expand all Collapse all


[0
]

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

ParticipantManagement

Retrieve details of a participant Deprecated

Retrieve details of a participant

Authorizations:

Bearer

path Parameters

participantId

required

integer <int32>

The ID of the participant

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/participants/{participantId}

https://example-host/v1.0/participants/{participantId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"uid": "string",
"isActive": true
}

Update a participant

Updates a participant

Authorizations:

Bearer

path Parameters

participantId

required

integer <int32>

The ID of the participant

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The request body

name	string Nullable
isActive	boolean
identityInternalUserIds	Array of strings <uuid> Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/participants/{participantId}

https://example-host/v1.0/participants/{participantId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"isActive": true,
"identityInternalUserIds": 
["string"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Retrieve information on participants

Retrieves information on participants

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/participants

https://example-host/v1.0/participants

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"uid": "string",
"name": "string",
"isActive": true,
"settingsUrl": "string"
}
]
}

Create a participant

Creates a participant

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The request body

name	string Nullable
identityInternalUserIds	Array of strings <uuid> Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/participants

https://example-host/v1.0/participants

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"identityInternalUserIds": 
["string"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Id": 1,
"UId": "f74c5020-16f2-46d9-b73a-7f3e0d732c96"
}

Search participants Deprecated

Searches participants

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/participants/search

https://example-host/v1.0/participants/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"name": "string",
"participantIds": 
[0
],
"isActive": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"uid": "string",
"name": "string",
"isActive": true
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

DFS Admin Services API (latest)

AccessPolicyManagement

Access policies

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Identity roles with authorization access policies

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Retrieve a list of API access policies.

Authorizations:

header Parameters

Responses

Response samples

Retrieve a specific access policy.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Retrieve a list of available system-wide permissions.

Authorizations:

header Parameters

Responses

Response samples

Retrieve information on a specific permission.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Check if a role has sufficient access policies for the specified permissions.

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+json

Responses

Request samples

Response samples

AuditContext

Generate an audit context

Authorizations:

header Parameters

Request Body schema: application/json-patch+json

Responses

Request samples

Response samples

BackOfficeManagement

Get a identity provider setting by provider id

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Retrieve a list of accessible (B/O) menu items and functionality.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Set a list of accessible (B/O) menu items and functionality.

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json-patch+json

Responses

Request samples

Response samples

Retrieve a list of available (B/O) menu items and functionality.

Authorizations:

header Parameters

Responses

Response samples

Retrieve a list of accessible (B/O) menu items and functionality Deprecated

Authorizations:

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json