UNPKG

@microsoft/msgraph-beta-sdk-users

Version:
98 lines 4.8 kB
import { type DirectoryObjectCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type GraphAdministrativeUnitRequestBuilder } from './graphAdministrativeUnit/index.js'; import { type GraphDirectoryRoleRequestBuilder } from './graphDirectoryRole/index.js'; import { type GraphGroupRequestBuilder } from './graphGroup/index.js'; import { type DirectoryObjectItemRequestBuilder } from './item/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the memberOf property of the microsoft.graph.user entity. */ export interface MemberOfRequestBuilder extends BaseRequestBuilder<MemberOfRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Casts the previous resource to administrativeUnit. */ get graphAdministrativeUnit(): GraphAdministrativeUnitRequestBuilder; /** * Casts the previous resource to directoryRole. */ get graphDirectoryRole(): GraphDirectoryRoleRequestBuilder; /** * Casts the previous resource to group. */ get graphGroup(): GraphGroupRequestBuilder; /** * Provides operations to manage the memberOf property of the microsoft.graph.user entity. * @param directoryObjectId The unique identifier of directoryObject * @returns {DirectoryObjectItemRequestBuilder} */ byDirectoryObjectId(directoryObjectId: string): DirectoryObjectItemRequestBuilder; /** * Get groups, directory roles, and administrative units that the user is a direct member of. This operation isn't transitive. To retrieve groups, directory roles, and administrative units that the user is a member through transitive membership, use the List user transitive memberOf API. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<DirectoryObjectCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/user-list-memberof?view=graph-rest-beta|Find more info here} */ get(requestConfiguration?: RequestConfiguration<MemberOfRequestBuilderGetQueryParameters> | undefined): Promise<DirectoryObjectCollectionResponse | undefined>; /** * Get groups, directory roles, and administrative units that the user is a direct member of. This operation isn't transitive. To retrieve groups, directory roles, and administrative units that the user is a member through transitive membership, use the List user transitive memberOf API. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<MemberOfRequestBuilderGetQueryParameters> | undefined): RequestInformation; } /** * Get groups, directory roles, and administrative units that the user is a direct member of. This operation isn't transitive. To retrieve groups, directory roles, and administrative units that the user is a member through transitive membership, use the List user transitive memberOf API. */ export interface MemberOfRequestBuilderGetQueryParameters { /** * Include count of items */ count?: boolean; /** * Expand related entities */ expand?: string[]; /** * Filter items by property values */ filter?: string; /** * Order items by property values */ orderby?: string[]; /** * Search items by search phrases */ search?: string; /** * Select properties to be returned */ select?: string[]; /** * Skip the first n items */ skip?: number; /** * Show only the first n items */ top?: number; } /** * Uri template for the request builder. */ export declare const MemberOfRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/memberOf{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const MemberOfRequestBuilderNavigationMetadata: Record<Exclude<keyof MemberOfRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const MemberOfRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map