import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Auth Token resource in Oracle Cloud Infrastructure Identity Domains service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/identity-domains/latest/AuthToken * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/identity_domains * * Create a user's Auth token. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testAuthToken = new oci.identity.DomainsAuthToken("test_auth_token", { * idcsEndpoint: testDomain.url, * schemas: ["urn:ietf:params:scim:schemas:oracle:idcs:authToken"], * attributeSets: [], * attributes: "", * authorization: authTokenAuthorization, * description: authTokenDescription, * expiresOn: authTokenExpiresOn, * id: authTokenId, * ocid: authTokenOcid, * resourceTypeSchemaVersion: authTokenResourceTypeSchemaVersion, * status: authTokenStatus, * tags: [{ * key: authTokenTagsKey, * value: authTokenTagsValue, * }], * urnietfparamsscimschemasoracleidcsextensionselfChangeUser: { * allowSelfChange: authTokenUrnietfparamsscimschemasoracleidcsextensionselfChangeUserAllowSelfChange === "true", * }, * user: { * ocid: testUser.ocid, * value: testUser.id, * }, * }); * ``` * * ## Import * * AuthTokens can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Identity/domainsAuthToken:DomainsAuthToken test_auth_token "idcsEndpoint/{idcsEndpoint}/authTokens/{authTokenId}" * ``` */ export declare class DomainsAuthToken extends pulumi.CustomResource { /** * Get an existing DomainsAuthToken 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?: DomainsAuthTokenState, opts?: pulumi.CustomResourceOptions): DomainsAuthToken; /** * Returns true if the given object is an instance of DomainsAuthToken. 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 DomainsAuthToken; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ readonly attributeSets: pulumi.Output; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ readonly attributes: pulumi.Output; /** * 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:** 2010242156 * * **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; /** * When the user's credential expire. * * **Added In:** 2109090424 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ readonly expiresOn: 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; /** * (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; /** * The user's credential status. * * **Added In:** 2109090424 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: never * * type: string * * uniqueness: none */ readonly status: 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; /** * (Updatable) token * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * type: string * * mutability: readOnly * * required: false * * returned: default * * idcsSensitive: hash_sc */ readonly token: pulumi.Output; /** * Controls whether a user can update themselves or not via User related APIs */ readonly urnietfparamsscimschemasoracleidcsextensionselfChangeUser: pulumi.Output; /** * The user linked to the Auth token. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: complex * * uniqueness: none */ readonly user: pulumi.Output; /** * Create a DomainsAuthToken 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: DomainsAuthTokenArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DomainsAuthToken resources. */ export interface DomainsAuthTokenState { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets?: pulumi.Input[] | undefined>; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes?: pulumi.Input; /** * 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:** 2010242156 * * **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; /** * When the user's credential expire. * * **Added In:** 2109090424 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ expiresOn?: 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>; /** * (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>; /** * The user's credential status. * * **Added In:** 2109090424 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: never * * type: string * * uniqueness: none */ status?: 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>; /** * (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; /** * (Updatable) token * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * type: string * * mutability: readOnly * * required: false * * returned: default * * idcsSensitive: hash_sc */ token?: pulumi.Input; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUser?: pulumi.Input; /** * The user linked to the Auth token. * * **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 DomainsAuthToken resource. */ export interface DomainsAuthTokenArgs { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets?: pulumi.Input[] | undefined>; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes?: pulumi.Input; /** * 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:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * mutability: readWrite * * required: false * * returned: default */ description?: pulumi.Input; /** * When the user's credential expire. * * **Added In:** 2109090424 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ expiresOn?: pulumi.Input; /** * The basic endpoint for the identity domain */ idcsEndpoint: 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[]>; /** * The user's credential status. * * **Added In:** 2109090424 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: never * * type: string * * uniqueness: none */ status?: 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>; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUser?: pulumi.Input; /** * The user linked to the Auth token. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: complex * * uniqueness: none */ user?: pulumi.Input; } //# sourceMappingURL=domainsAuthToken.d.ts.map