# Cadency IAM APIs ## Description This is version `1.4.0` of this API documentation. Last update on Apr 3, 2025. Welcome to the documentation for the IAM APIs. Here, you will find comprehensive information and resources related to the Identity Access Management (IAM) APIs. These APIs provide a set of powerful tools and functionalities for managing user identities within Cadency. Please refer to the documentation sections below to explore the available API endpoints, request/response formats, authentication methods, and other relevant details. # Overview The Identity Access Management (IAM) APIs facilitate user identity management in Cadency, streamlining the process of managing user identities. By integrating with IAM, user access changes made in the identity service will automatically propagate to the corresponding user records in Cadency. Key automation processes supported by this integration include: 1. **User Creation**: When new corporate credentials are created for an employee through an identity provider, a corresponding Cadency user record is automatically generated for that employee. 2. **User Deactivation**: If an employee's corporate credentials are disabled through an identity provider, their Cadency user record will be automatically disabled. 3. **Roles or Group Membership**: IAM integration allows for synchronization of group membership between your identity service and Cadency, ensuring consistency in roles and group assignments. # Authentication ## Bearer Authentication An authentication access token is required to access the IAM APIs. Note that: * All requests to the IAM APIs should include the token in the Authorization header, i.e. `Authorization: Bearer {access token}`. ## Servers - Sandbox server URL: https://localhost:8080 (Sandbox server URL) ## Authentication ## Endpoints and operations ### [Users API](https://developer.trintech.com/doc/iam-api/group/endpoint-users.md) - [Get Users](https://developer.trintech.com/doc/iam-api/operation/operation-get_users.md) - [Update Users](https://developer.trintech.com/doc/iam-api/operation/operation-put_users.md) - [Create Users](https://developer.trintech.com/doc/iam-api/operation/operation-post_users.md) - [Patch Users](https://developer.trintech.com/doc/iam-api/operation/operation-patch_users.md) - [Get Single User](https://developer.trintech.com/doc/iam-api/operation/operation-get_user.md) ### [User Roles API](https://developer.trintech.com/doc/iam-api/group/endpoint-user-roles.md) - [Get User Roles](https://developer.trintech.com/doc/iam-api/operation/operation-get_user_roles.md) - [Replace User Roles](https://developer.trintech.com/doc/iam-api/operation/operation-put_user_roles.md) - [Replace User Roles](https://developer.trintech.com/doc/iam-api/operation/operation-post_user_roles.md) - [Delete User Roles](https://developer.trintech.com/doc/iam-api/operation/operation-delete_user_roles.md) - [Patch User Roles](https://developer.trintech.com/doc/iam-api/operation/operation-patch_user_roles.md) ### [User Groups API](https://developer.trintech.com/doc/iam-api/group/endpoint-user-groups.md) - [Get User Groups](https://developer.trintech.com/doc/iam-api/operation/operation-get_usergroups.md) - [Create User Group](https://developer.trintech.com/doc/iam-api/operation/operation-post_usergroup.md) - [Get Single User Group](https://developer.trintech.com/doc/iam-api/operation/operation-get_usergroup.md) - [Update user group](https://developer.trintech.com/doc/iam-api/operation/operation-put_usergroup.md) - [Delete User Group](https://developer.trintech.com/doc/iam-api/operation/operation-delete_usergroup.md) - [Patch User Group](https://developer.trintech.com/doc/iam-api/operation/operation-patch_usergroup.md) - [Get User Group Users](https://developer.trintech.com/doc/iam-api/operation/operation-get_usergroup_users.md) - [Update user group users](https://developer.trintech.com/doc/iam-api/operation/operation-put_usergroup_users.md) - [Add User Group User](https://developer.trintech.com/doc/iam-api/operation/operation-post_usergroup_users.md) - [Delete User Group Users](https://developer.trintech.com/doc/iam-api/operation/operation-delete_usergroup_users.md) ### [User Operational Structures API](https://developer.trintech.com/doc/iam-api/group/endpoint-user-operational-structures.md) - [Get User Operational Structures](https://developer.trintech.com/doc/iam-api/operation/operation-get_user_operational-structures.md) - [Replace User Operational Structures](https://developer.trintech.com/doc/iam-api/operation/operation-put_user_operational-structures.md) - [Add User Operational Structures](https://developer.trintech.com/doc/iam-api/operation/operation-post_user_operational-structures.md) - [Remove User Operational Structures](https://developer.trintech.com/doc/iam-api/operation/operation-delete_user_operational-structures.md) ### [User Sectors API](https://developer.trintech.com/doc/iam-api/group/endpoint-user-sectors.md) - [Get User Sectors](https://developer.trintech.com/doc/iam-api/operation/operation-get_user_sectors.md) - [Replace User Sectors](https://developer.trintech.com/doc/iam-api/operation/operation-put_user_sectors.md) - [Add User Sectors](https://developer.trintech.com/doc/iam-api/operation/operation-post_user_sectors.md) - [Remove User Sectors](https://developer.trintech.com/doc/iam-api/operation/operation-delete_user_sectors.md) ### [Departments API](https://developer.trintech.com/doc/iam-api/group/endpoint-departments.md) - [Get Departments](https://developer.trintech.com/doc/iam-api/operation/operation-get_departments.md) ### [Locations API](https://developer.trintech.com/doc/iam-api/group/endpoint-locations.md) - [Get Locations](https://developer.trintech.com/doc/iam-api/operation/operation-get_locations.md) ### [Roles API](https://developer.trintech.com/doc/iam-api/group/endpoint-roles.md) - [Get Supported Roles](https://developer.trintech.com/doc/iam-api/operation/operation-get_roles_list.md) ### [Match Security Profiles API](https://developer.trintech.com/doc/iam-api/group/endpoint-security-profiles.md) - [Get Match Security Profiles](https://developer.trintech.com/doc/iam-api/operation/operation-get_security_profiles.md) - [Get Single Match Security Profile](https://developer.trintech.com/doc/iam-api/operation/operation-get_security_profile.md) ### [Match Operational Structures API](https://developer.trintech.com/doc/iam-api/group/endpoint-operational-structures.md) - [Get Match Operational Structures](https://developer.trintech.com/doc/iam-api/operation/operation-get_operational_structures.md) - [Get Single Match Operational Structure](https://developer.trintech.com/doc/iam-api/operation/operation-get_operational_structure.md) ### [Match Sectors API](https://developer.trintech.com/doc/iam-api/group/endpoint-sectors.md) - [Get Match Sectors](https://developer.trintech.com/doc/iam-api/operation/operation-get_sectors.md) - [Get Single Match Sector](https://developer.trintech.com/doc/iam-api/operation/operation-get_sector.md) [Powered by Bump.sh](https://bump.sh)