@microsoft/msgraph-beta-sdk-users
Version:
Users fluent API for Microsoft Graph
79 lines • 4.28 kB
TypeScript
import { type QrPin } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type UpdatePinRequestBuilder } from './updatePin/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the pin property of the microsoft.graph.qrCodePinAuthenticationMethod entity.
*/
export interface PinRequestBuilder extends BaseRequestBuilder<PinRequestBuilder> {
/**
* Provides operations to call the updatePin method.
*/
get updatePin(): UpdatePinRequestBuilder;
/**
* Delete navigation property pin for users
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
/**
* The PIN linked to the QR Code auth method of the user.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<QrPin>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<PinRequestBuilderGetQueryParameters> | undefined): Promise<QrPin | undefined>;
/**
* Reset a user's PIN and generate a new temporary PIN that's represented by a qrPin object and is linked to the user's QR Code authentication method object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<QrPin>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/qrpin-update?view=graph-rest-beta|Find more info here}
*/
patch(body: QrPin, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<QrPin | undefined>;
/**
* Delete navigation property pin for users
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
/**
* The PIN linked to the QR Code auth method of the user.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<PinRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Reset a user's PIN and generate a new temporary PIN that's represented by a qrPin object and is linked to the user's QR Code authentication method object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPatchRequestInformation(body: QrPin, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* The PIN linked to the QR Code auth method of the user.
*/
export interface PinRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const PinRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/authentication/qrCodePinMethod/pin{?%24expand,%24select}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const PinRequestBuilderNavigationMetadata: Record<Exclude<keyof PinRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const PinRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map