import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the My Api Key resource in Oracle Cloud Infrastructure Identity Domains service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/identity-domains/latest/MyApiKey * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/identity_domains * * Add a user's own API key. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testMyApiKey = new oci.identity.DomainsMyApiKey("test_my_api_key", { * idcsEndpoint: testDomain.url, * key: myApiKeyKey, * schemas: ["urn:ietf:params:scim:schemas:oracle:idcs:apikey"], * authorization: myApiKeyAuthorization, * description: myApiKeyDescription, * id: myApiKeyId, * ocid: myApiKeyOcid, * resourceTypeSchemaVersion: myApiKeyResourceTypeSchemaVersion, * tags: [{ * key: myApiKeyTagsKey, * value: myApiKeyTagsValue, * }], * user: { * ocid: myApiKeyUserOcid, * value: myApiKeyUserValue, * }, * }); * ``` * * ## Import * * MyApiKeys can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Identity/domainsMyApiKey:DomainsMyApiKey test_my_api_key "idcsEndpoint/{idcsEndpoint}/myApiKeys/{myApiKeyId}" * ``` */ export declare class DomainsMyApiKey extends pulumi.CustomResource { /** * Get an existing DomainsMyApiKey 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: string, id: pulumi.Input, state?: DomainsMyApiKeyState, opts?: pulumi.CustomResourceOptions): DomainsMyApiKey; /** * Returns true if the given object is an instance of DomainsMyApiKey. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is DomainsMyApiKey; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ readonly authorization: pulumi.Output; /** * (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ readonly compartmentOcid: pulumi.Output; /** * (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ readonly deleteInProgress: pulumi.Output; /** * Description * * **Added In:** 2101262133 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * mutability: readWrite * * required: false * * returned: default */ readonly description: pulumi.Output; /** * (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ readonly domainOcid: pulumi.Output; /** * (Updatable) Fingerprint * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * type: string * * mutability: readOnly * * required: true * * returned: default */ readonly fingerprint: pulumi.Output; /** * (Updatable) The User or App who created the Resource * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: complex */ readonly idcsCreatedBies: pulumi.Output; /** * The basic endpoint for the identity domain */ readonly idcsEndpoint: pulumi.Output; /** * (Updatable) The User or App who modified the Resource * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: complex */ readonly idcsLastModifiedBies: pulumi.Output; /** * (Updatable) The release number when the resource was upgraded. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ readonly idcsLastUpgradedInRelease: pulumi.Output; /** * (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ readonly idcsPreventedOperations: pulumi.Output; /** * Key * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsPii: true * * type: string * * mutability: immutable * * required: true * * returned: default */ readonly key: pulumi.Output; /** * (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]] * * type: complex */ readonly metas: pulumi.Output; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: global */ readonly ocid: pulumi.Output; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ readonly resourceTypeSchemaVersion: pulumi.Output; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ readonly schemas: pulumi.Output; /** * A list of tags on this resource. * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ readonly tags: pulumi.Output; /** * (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ readonly tenancyOcid: pulumi.Output; /** * The user linked to the API key. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: complex * * uniqueness: none */ readonly user: pulumi.Output; /** * Create a DomainsMyApiKey resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DomainsMyApiKeyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DomainsMyApiKey resources. */ export interface DomainsMyApiKeyState { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization?: pulumi.Input; /** * (Updatable) Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ compartmentOcid?: pulumi.Input; /** * (Updatable) A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ deleteInProgress?: pulumi.Input; /** * Description * * **Added In:** 2101262133 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * mutability: readWrite * * required: false * * returned: default */ description?: pulumi.Input; /** * (Updatable) Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ domainOcid?: pulumi.Input; /** * (Updatable) Fingerprint * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * type: string * * mutability: readOnly * * required: true * * returned: default */ fingerprint?: pulumi.Input; /** * (Updatable) The User or App who created the Resource * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: complex */ idcsCreatedBies?: pulumi.Input[] | undefined>; /** * The basic endpoint for the identity domain */ idcsEndpoint?: pulumi.Input; /** * (Updatable) The User or App who modified the Resource * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: complex */ idcsLastModifiedBies?: pulumi.Input[] | undefined>; /** * (Updatable) The release number when the resource was upgraded. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ idcsLastUpgradedInRelease?: pulumi.Input; /** * (Updatable) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ idcsPreventedOperations?: pulumi.Input[] | undefined>; /** * Key * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsPii: true * * type: string * * mutability: immutable * * required: true * * returned: default */ key?: pulumi.Input; /** * (Updatable) A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]] * * type: complex */ metas?: pulumi.Input[] | undefined>; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: global */ ocid?: pulumi.Input; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion?: pulumi.Input; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ schemas?: pulumi.Input[] | undefined>; /** * A list of tags on this resource. * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ tags?: pulumi.Input[] | undefined>; /** * (Updatable) Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ tenancyOcid?: pulumi.Input; /** * The user linked to the API key. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: complex * * uniqueness: none */ user?: pulumi.Input; } /** * The set of arguments for constructing a DomainsMyApiKey resource. */ export interface DomainsMyApiKeyArgs { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization?: pulumi.Input; /** * Description * * **Added In:** 2101262133 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * mutability: readWrite * * required: false * * returned: default */ description?: pulumi.Input; /** * The basic endpoint for the identity domain */ idcsEndpoint: pulumi.Input; /** * Key * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsPii: true * * type: string * * mutability: immutable * * required: true * * returned: default */ key: pulumi.Input; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: global */ ocid?: pulumi.Input; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion?: pulumi.Input; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ schemas: pulumi.Input[]>; /** * A list of tags on this resource. * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ tags?: pulumi.Input[] | undefined>; /** * The user linked to the API key. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: complex * * uniqueness: none */ user?: pulumi.Input; } //# sourceMappingURL=domainsMyApiKey.d.ts.map