@microsoft/msgraph-beta-sdk-applications
Version:
Applications fluent API for Microsoft Graph
72 lines • 5.29 kB
TypeScript
import { type FederatedIdentityCredential } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity.
*/
export interface FederatedIdentityCredentialsWithNameRequestBuilder extends BaseRequestBuilder<FederatedIdentityCredentialsWithNameRequestBuilder> {
/**
* Deletes a federatedIdentityCredential object from an application.
* @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
* @see {@link https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-beta|Find more info here}
*/
delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
/**
* Read the properties and relationships of a federatedIdentityCredential object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<FederatedIdentityCredential>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<FederatedIdentityCredentialsWithNameRequestBuilderGetQueryParameters> | undefined): Promise<FederatedIdentityCredential | undefined>;
/**
* Create a new federatedIdentityCredential object for an application if it doesn't exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<FederatedIdentityCredential>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-beta|Find more info here}
*/
patch(body: FederatedIdentityCredential, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<FederatedIdentityCredential | undefined>;
/**
* Deletes a federatedIdentityCredential object from an application.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
/**
* Read the properties and relationships of a federatedIdentityCredential object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<FederatedIdentityCredentialsWithNameRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create a new federatedIdentityCredential object for an application if it doesn't exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPatchRequestInformation(body: FederatedIdentityCredential, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Read the properties and relationships of a federatedIdentityCredential object.
*/
export interface FederatedIdentityCredentialsWithNameRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const FederatedIdentityCredentialsWithNameRequestBuilderUriTemplate = "{+baseurl}/applications/{application%2Did}/federatedIdentityCredentials(name='{name}'){?%24expand,%24select}";
/**
* Metadata for all the requests in the request builder.
*/
export declare const FederatedIdentityCredentialsWithNameRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map