Interface IIdentityRESTClient

Namespace

FoundationaLLM.Client.Management.Interfaces

Assembly

FoundationaLLM.Client.Management.dll

Provides methods to manage calls to the Management API's identity endpoints.

public interface IIdentityRESTClient

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

GetGroupAsync(string)

Retrieves a specific group account by its identifier.

Task<Group> GetGroupAsync(string groupId)

Parameters

groupId string

Returns

Task<Group>

GetUserAsync(string)

Retrieves a specific user account by its identifier.

Task<User> GetUserAsync(string userId)

Parameters

userId string

Returns

Task<User>

RetrieveGroupsAsync(ObjectQueryParameters)

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

Task<IEnumerable<Group>> RetrieveGroupsAsync(ObjectQueryParameters parameters)

Parameters

parameters ObjectQueryParameters

Returns

Task<IEnumerable<Group>>

RetrieveObjectsByIdsAsync(ObjectQueryParameters)

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

Task<IEnumerable<DirectoryObject>> RetrieveObjectsByIdsAsync(ObjectQueryParameters parameters)

Parameters

parameters ObjectQueryParameters

Returns

Task<IEnumerable<DirectoryObject>>

RetrieveUsersAsync(ObjectQueryParameters)

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

Task<IEnumerable<User>> RetrieveUsersAsync(ObjectQueryParameters parameters)

Parameters

parameters ObjectQueryParameters

Returns

Task<IEnumerable<User>>