Interface IIdentityManagementService

Namespace

FoundationaLLM.Common.Interfaces

Assembly

FoundationaLLM.Common.dll

Provides identity management services.

public interface IIdentityManagementService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

GetGroupsForPrincipal(string)

Retrieves the group identifiers list of the groups where the specified user principal is a member.

Task<List<string>> GetGroupsForPrincipal(string userIdentifier)

Parameters

userIdentifier string

The user identifier for which group membership is retrieved. Can be either an object id or a user principal name (UPN).

Returns

Task<List<string>>

GetObjectsByIds(ObjectQueryParameters)

Retrieves user and group objects by the passed in list of IDs.

Task<List<ObjectQueryResult>> GetObjectsByIds(ObjectQueryParameters parameters)

Parameters

parameters ObjectQueryParameters

Returns

Task<List<ObjectQueryResult>>

GetServicePrincipalById(string)

Retrieves a security principal by its identifier.

Task<ObjectQueryResult> GetServicePrincipalById(string servicePrincipalId)

Parameters

servicePrincipalId string

The service principal identifier used to retrieve a single service principal.

Returns

Task<ObjectQueryResult>

GetServicePrincipals(ObjectQueryParameters)

Retrieves a list of service principals with filtering and paging options.

Task<PagedResponse<ObjectQueryResult>> GetServicePrincipals(ObjectQueryParameters queryParams)

Parameters

queryParams ObjectQueryParameters

The filtering and paging options used when retrieving service principals.

Returns

Task<PagedResponse<ObjectQueryResult>>

GetUserById(string)

Retrieves a user account by its identifier.

Task<ObjectQueryResult> GetUserById(string userId)

Parameters

userId string

The user identifier used to retrieve a single user account.

Returns

Task<ObjectQueryResult>

GetUserGroupById(string)

Retrieves a group account by its identifier.

Task<ObjectQueryResult> GetUserGroupById(string groupId)

Parameters

groupId string

The group account identifier used to retrieve a single group account.

Returns

Task<ObjectQueryResult>

GetUserGroups(ObjectQueryParameters)

Retrieves a list of group accounts with filtering and paging options.

Task<PagedResponse<ObjectQueryResult>> GetUserGroups(ObjectQueryParameters queryParams)

Parameters

queryParams ObjectQueryParameters

The filtering and paging options used when retrieving group accounts.

Returns

Task<PagedResponse<ObjectQueryResult>>

GetUsers(ObjectQueryParameters)

Retrieves a list of user accounts with filtering and paging options.

Task<PagedResponse<ObjectQueryResult>> GetUsers(ObjectQueryParameters queryParams)

Parameters

queryParams ObjectQueryParameters

The filtering and paging options used when retrieving users.

Returns

Task<PagedResponse<ObjectQueryResult>>