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 OU 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 | √ | × |
| List Users | List the information of internal users, LDAP users, and SSO users of the OU, including the users’ recent login times | /enos-iam-service/v2.4/open/user/logintime/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 | √ | × |
| Delete User | Delete an internal user, LDAP user, or SSO user in the OU | /enos-iam-service/v2.4/open/user/logintime/delete | √ | × |
| Disable User | Disable an internal user in the OU | /enos-iam-service/v2.4/open/user/disable | √ | × |
| Enable User | Enable an internal user in the OU | /enos-iam-service/v2.4/open/user/enable | √ | × |
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 | √ | × |
Policy¶
| Operation Name | Description | URL | EnOS Cloud | EnOS Edge |
|---|---|---|---|---|
| Get Policy | Get the policy information | /enos-iam-service/v2.3/policy/info | √ | × |
| List Policies | List the policies of an OU | /enos-iam-service/v2.3/policy/list | √ | × |
| List Policies by User | List the policies bound to a user | /enos-iam-service/v2.3/user/policy/list | √ | × |
| List Policies by Service Account | List the policies for a service account | /enos-iam-service/v2.3/policy/service/list | √ | × |
| Attach Policy to User/User Group/Service Account | Attach policies to a user, user group, or service account | /enos-iam-service/v2.3/policy/grant | √ | × |
| Remove Policy from User/User Group/Service Account | Remove policies from a user, user group, or service account | /enos-iam-service/v2.3/policy/revoke | √ | × |
Policy Configuration Metadata¶
| Operation Name | Description | URL | EnOS Cloud | EnOS Edge |
|---|---|---|---|---|
| Get Resource | Get the information of a resource | /enos-iam-service/v2.3/iam/ctrl/api/open/v3/get/resource | √ | × |
| Get Resource Operation Permissions | Get the operation permissions that can be selected for a resource based on the resource type | /enos-iam-service/v2.3/resource/get/action | √ | × |
| Get Resource Condition | Get the conditions of a resource based on the resource type | /enos-iam-service/v2.3/resource/get/condition | √ | × |
| Get Resource Provider | Get the provider information of a resource based on the resource type | /enos-iam-service/v2.3/resource/provider/get | √ | × |