update docs

Signed-off-by: annie_wangli <annie.wangli@huawei.com>
This commit is contained in:
annie_wangli
2022-03-17 19:42:36 +08:00
parent fb9d59845e
commit 23d9d7aab5
+12 -13
View File
@@ -1,12 +1,11 @@
# User Identity Management (useridm)
## Introduction
As a basic component of the Identity & Access Management (IAM) subsystem, User Identity Management (useridm) provides a unified interface for managing user credential information in the system and invokes authentication resources through the authentication executor management module to implement lifecycle management and secure storage of user credentials.
As a basic component of the user Identity & Access Management (IAM) subsystem, User Identity Management (useridm) provides a unified interface for managing user credential information in the system and invokes authentication resources through the authentication executor management module to implement lifecycle management and secure storage of user credentials.
**Figure 1** User identity credential management architecture
**Figure 1** useridm architecture
<img src="figures/useridm_architecture.png" alt="useridm_architecture" style="zoom:80%;" />
@@ -16,11 +15,11 @@ As a basic component of the Identity & Access Management (IAM) subsystem, User I
//base/user_iam/user_idm
├── frameworks # Framework code
├── interfaces # Directory for storing external interfaces
│ └── innerkits # Header files exposed to the internal subsystem
├── sa_profile # Profile of the Service Ability
├── services # Implementation of Service Ability services
│ └── innerkits # Header files exposed to the internal subsystems
├── sa_profile # Profile of the Service ability
├── services # Implementation of the Service ability
├── unittest # Directory for storing test code
├── utils # Directory for storing utility code
├── utils # Directory for storing utility code
├── bundle.json # Component description file
└── useridm.gni # Build configuration
```
@@ -36,7 +35,7 @@ As a basic component of the Identity & Access Management (IAM) subsystem, User I
| ------ | -------------------------------- |
| addCredential(credentialInfo : CredentialInfo, callback : IIdmCallback) : void; | Adds a user credential.|
| updateCredential(credentialInfo:CredentialInfo, callback:IIdmCallback) : void; | Updates a user credential.|
| delUser(token : Uint8Array, callback : IIdmCallback) : void; | Deletes a user password. When a user password is deleted, all authentication credentials of the user are also deleted.|
| delUser(token : Uint8Array, callback : IIdmCallback) : void; | Deletes a Personal Information Number (PIN). When a PIN is deleted, all authentication credentials of the user are also deleted.|
| delCred(credentialId : Uint8Array, token : Uint8Array, callback : IIdmCallback) : void; | Deletes a user credential.|
**Table 2** API for querying user credential information
@@ -52,12 +51,12 @@ As a basic component of the Identity & Access Management (IAM) subsystem, User I
## Repositories Involved
[useriam_auth_executor_mgr](https://gitee.com/openharmony/useriam_auth_executor_mgr/blob/master/README.md)
[useriam_auth_executor_mgr](https://gitee.com/openharmony/useriam_auth_executor_mgr)
**[useriam_user_idm](https://gitee.com/openharmony/useriam_user_idm/blob/master/README.md)**
**[useriam_user_idm](https://gitee.com/openharmony/useriam_user_idm)**
[useriam_user_auth](https://gitee.com/openharmony/useriam_user_auth/blob/master/README.md)
[useriam_user_auth](https://gitee.com/openharmony/useriam_user_auth)
[useriam_pin_auth](https://gitee.com/openharmony/useriam_pin_auth/blob/master/README.md)
[useriam_pin_auth](https://gitee.com/openharmony/useriam_pin_auth)
useriam_faceauth
[useriam_faceauth](https://gitee.com/openharmony/useriam_faceauth)