IAM Service API Overview
EnOS Identity and Access Management (IAM) helps you manage user identities and control user access to your resources in EnOS. IAM enables you to manage user account lifecycles, authenticate user identities, and control user access rights to the resources in EnOS. For more information about IAM service, see IAM Overview.
The APIs in the IAM service are some of the APIs EnOS provides that cover the core business processes of the system. For more information on EnOS APIs and the different APIs that EnOS provides, see About EnOS API.
For more information on how to invoke EnOS APIs, see Get Started with EnOS API.
Refer to the table below for the list of IAM Service APIs, and whether they can be used by EnOS Cloud and EnOS Edge.
Login and Session
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
Log In |
Log in EnOS |
/enos-iam-service/v2.0/login |
√ |
× |
Get Session Information |
Get the login session information |
/enos-iam-service/v2.0/session/info |
√ |
× |
Organization
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
Get Organization |
Get the detailed information of the organization |
/enos-iam-service/v2.0/organization/info |
√ |
× |
User
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
List User Organization |
List the organization to which a user belongs |
/enos-iam-service/v2.0/user/organization/list |
√ |
× |
List User Groups by User |
List the user groups that the user has joined in the current organization |
/enos-iam-service/v2.3/user/usergroup/list |
√ |
× |
Create SSO User |
Create an SSO user |
/enos-iam-service/v2.3/user/sso/create |
√ |
× |
List SSO Users |
List the SSO users of the specified organization |
/enos-iam-service/v2.3/user/sso/list |
√ |
× |
Update SSO User |
Update the details of an SSO user |
/enos-iam-service/v2.3/user/sso/update |
√ |
× |
Delete SSO User |
Delete an SSO user from the OU |
/enos-iam-service/v2.3/user/sso/delete |
√ |
× |
User Group
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
Create User Group |
Create a user group |
/enos-iam-service/v2.3/usergroup/add |
√ |
× |
Get User Group |
Get the user group information |
/enos-iam-service/v2.3/usergroup/info |
√ |
× |
List User Groups |
List the user groups under an OU |
/enos-iam-service/v2.3/usergroup/list |
√ |
× |
Update User Group |
Update user group information |
/enos-iam-service/v2.3/usergroup/modify |
√ |
× |
Delete User Group |
Delete a user group from the OU |
/enos-iam-service/v2.3/usergroup/delete |
√ |
× |
Add User to User Group |
Add users to a user group |
/enos-iam-service/v2.3/usergroup/append |
√ |
× |
Remove User from User Group |
Remove users from a user group |
/enos-iam-service/v2.3/usergroup/remove |
√ |
× |