mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Update doc (#8085)
This commit is contained in:
Eugenio Romano
GitHub
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2019-07-12
|
||||
---
|
||||
|
||||
# [Identity user service](lib/core/src/lib/services/identity-user.service.ts "Defined in identity-user.service.ts")
|
||||
# [Identity user service](../../../lib/process-services-cloud/src/lib/people/services/identity-user.service.ts "Defined in identity-user.service.ts")
|
||||
|
||||
Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users.
|
||||
|
||||
@@ -13,136 +13,14 @@ Gets OAuth2 personal details and roles for users and performs CRUD operations on
|
||||
|
||||
### Methods
|
||||
|
||||
- **assignRoles**(userId: `string`, roles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Assigns roles to the user.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- _roles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - Array of roles.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the role assigned.
|
||||
- **changePassword**(userId: `string`, newPassword: [`IdentityUserPasswordModel`](lib/core/src/lib/services/identity-user.service.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Changes user password.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- _newPassword:_ [`IdentityUserPasswordModel`](lib/core/src/lib/services/identity-user.service.interface.ts) -
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the password changed.
|
||||
- **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Checks if a user has any application role.
|
||||
- _userId:_ `string` - ID of the target user
|
||||
- _applicationName:_ `string` - Name of the application
|
||||
- _roleNames:_ `string[]` - List of role names to check for
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one or more of the roles, false otherwise
|
||||
- **checkUserHasAnyClientAppRole**(userId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Checks whether a user has any of the client app roles.
|
||||
- _userId:_ `string` - ID of the target user
|
||||
- _clientId:_ `string` - ID of the client app
|
||||
- _roleNames:_ `string[]` - List of role names to check for
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one or more of the roles, false otherwise
|
||||
- **checkUserHasApplicationAccess**(userId: `string`, applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Checks if a user has access to an application.
|
||||
- _userId:_ `string` - ID of the user
|
||||
- _applicationName:_ `string` - Name of the application
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
|
||||
- **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Checks whether user has access to a client app.
|
||||
- _userId:_ `string` - ID of the target user
|
||||
- _clientId:_ `string` - ID of the client app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
|
||||
- **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Checks if a user has one of the roles from a list.
|
||||
- _userId:_ `string` - ID of the target user
|
||||
- _roleNames:_ `string[]` - Array of roles to check for
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one of the roles, false otherwise
|
||||
- **createUser**(newUser: [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Creates new user.
|
||||
- _newUser:_ [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts) - Object containing the new user details.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user created.
|
||||
- **deleteUser**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Deletes User.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user deleted.
|
||||
- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Find users based on email input.
|
||||
- _email:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users
|
||||
- **findUserById**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Find users based on id input.
|
||||
- _id:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - users object
|
||||
- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Find users based on username input.
|
||||
- _username:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users
|
||||
- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Find users based on search input.
|
||||
- _search:_ `string` - Search query string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users
|
||||
- **getAssignedRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
||||
Gets assigned roles.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of assigned roles information objects
|
||||
- **getAvailableRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
||||
Gets available roles
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles information objects
|
||||
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
|
||||
Gets the client ID for an application.
|
||||
- _applicationName:_ `string` - Name of the application
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - Client ID string
|
||||
- **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
|
||||
Get client roles of a user for a particular client.
|
||||
- _userId:_ `string` - ID of the target user
|
||||
- _clientId:_ `string` - ID of the client app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of client roles
|
||||
- **getCurrentUserInfo**(): [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts)<br/>
|
||||
- **getCurrentUserInfo**(): [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)<br/>
|
||||
Gets the name and other basic details of the current user.
|
||||
- **Returns** [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts) - The user's details
|
||||
- **getEffectiveRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
||||
Gets effective roles.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of composite roles information objects
|
||||
- **getInvolvedGroups**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`<br/>
|
||||
Gets involved groups.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - Array of involved groups information objects.
|
||||
- **getTotalUsersCount**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<number>`<br/>
|
||||
Gets users total count.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<number>` - Number of users count.
|
||||
- **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
||||
Gets a list of roles for a user.
|
||||
- _userId:_ `string` - ID of the user
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of role info objects
|
||||
- **getUsers**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Gets details for all users.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects
|
||||
- **getUsersByRolesWithCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Gets an array of users (including the current user) who have any of the roles in the supplied list.
|
||||
- _roleNames:_ `string[]` - List of role names to look for
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects
|
||||
- **getUsersByRolesWithoutCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
|
||||
Gets an array of users (not including the current user) who have any of the roles in the supplied list.
|
||||
- _roleNames:_ `string[]` - List of role names to look for
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects
|
||||
- **joinGroup**(joinGroupRequest: [`IdentityJoinGroupRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Joins group.
|
||||
- _joinGroupRequest:_ [`IdentityJoinGroupRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts) - Details of join group request (IdentityJoinGroupRequestModel).
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user joined the group.
|
||||
- **leaveGroup**(userId: `any`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Leaves group.
|
||||
- _userId:_ `any` - Id of the user.
|
||||
- _groupId:_ `string` - Id of the group.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user left the group.
|
||||
- **queryUsers**(requestQuery: [`IdentityUserQueryCloudRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.interface.ts)`>`<br/>
|
||||
Gets details for all users.
|
||||
- _requestQuery:_ [`IdentityUserQueryCloudRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts) -
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.interface.ts)`>` - Array of user information objects.
|
||||
- **removeRoles**(userId: `string`, removedRoles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Removes assigned roles.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- _removedRoles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` -
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the role removed.
|
||||
- **updateUser**(userId: `string`, updatedUser: [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Updates user details.
|
||||
- _userId:_ `string` - Id of the user.
|
||||
- _updatedUser:_ [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts) - Object containing the user details.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user updated.
|
||||
- **Returns** [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) - The user's details
|
||||
- **search**(name: `string`, filters?: [`IdentityUserFilterInterface`](../../../lib/process-services-cloud/src/lib/people/services/identity-user-filter.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`[]>`<br/>
|
||||
Search users based on name input and filters.
|
||||
- _name:_ `string` - Search query string
|
||||
- _filters:_ [`IdentityUserFilterInterface`](../../../lib/process-services-cloud/src/lib/people/services/identity-user-filter.interface.ts) - (Optional)
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`[]>` - List of users
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
Reference in New Issue
Block a user