@pulumi/azuread/claimsMappingPolicy.js

A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ClaimsMappingPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Manages a Claims Mapping Policy within Azure Active Directory.
 *
 * ## API Permissions
 *
 * The following API permissions are required in order to use this resource.
 *
 * When authenticated with a service principal, this resource requires the following application roles: `Policy.ReadWrite.ApplicationConfiguration` and `Policy.Read.All`
 *
 * When authenticated with a user principal, this resource requires one of the following directory roles: `Application Administrator` or `Global Administrator`
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const myPolicy = new azuread.ClaimsMappingPolicy("my_policy", {
 *     definitions: [JSON.stringify({
 *         claimsMappingPolicy: {
 *             claimsSchema: [
 *                 {
 *                     ID: "employeeid",
 *                     jwtClaimType: "name",
 *                     samlClaimType: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
 *                     source: "user",
 *                 },
 *                 {
 *                     ID: "tenantcountry",
 *                     jwtClaimType: "country",
 *                     samlClaimType: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country",
 *                     source: "company",
 *                 },
 *             ],
 *             includeBasicClaimSet: "true",
 *             version: 1,
 *         },
 *     })],
 *     displayName: "My Policy",
 * });
 * ```
 *
 * ## Import
 *
 * Claims Mapping Policy can be imported using the `id`, e.g.
 *
 * ```sh
 * $ pulumi import azuread:index/claimsMappingPolicy:ClaimsMappingPolicy my_policy 00000000-0000-0000-0000-000000000000
 * ```
 */
class ClaimsMappingPolicy extends pulumi.CustomResource {
    /**
     * Get an existing ClaimsMappingPolicy resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name, id, state, opts) {
        return new ClaimsMappingPolicy(name, state, Object.assign(Object.assign({}, opts), { id: id }));
    }
    /**
     * Returns true if the given object is an instance of ClaimsMappingPolicy.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj) {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === ClaimsMappingPolicy.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["definitions"] = state ? state.definitions : undefined;
            resourceInputs["displayName"] = state ? state.displayName : undefined;
        }
        else {
            const args = argsOrState;
            if ((!args || args.definitions === undefined) && !opts.urn) {
                throw new Error("Missing required property 'definitions'");
            }
            if ((!args || args.displayName === undefined) && !opts.urn) {
                throw new Error("Missing required property 'displayName'");
            }
            resourceInputs["definitions"] = args ? args.definitions : undefined;
            resourceInputs["displayName"] = args ? args.displayName : undefined;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(ClaimsMappingPolicy.__pulumiType, name, resourceInputs, opts);
    }
}
exports.ClaimsMappingPolicy = ClaimsMappingPolicy;
/** @internal */
ClaimsMappingPolicy.__pulumiType = 'azuread:index/claimsMappingPolicy:ClaimsMappingPolicy';
//# sourceMappingURL=claimsMappingPolicy.js.map