import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Setting resource in Oracle Cloud Infrastructure Identity Domains service. * * Get Settings * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testSetting = oci.identity.getDomainsSetting({ * idcsEndpoint: testDomain.url, * settingId: "Settings", * attributeSets: ["all"], * attributes: "", * authorization: settingAuthorization, * resourceTypeSchemaVersion: settingResourceTypeSchemaVersion, * }); * ``` */ export declare function getDomainsSetting(args: GetDomainsSettingArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getDomainsSetting. */ export interface GetDomainsSettingArgs { /** * 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?: string[]; /** * 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?: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization?: string; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * 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?: string; /** * ID of the resource */ settingId: string; } /** * A collection of values returned by getDomainsSetting. */ export interface GetDomainsSettingResult { /** * Indicates whether all the Apps in this customer tenancy should trust each other. A value of true overrides the 'defaultTrustScope' attribute here in Settings, as well as any App-specific 'trustScope' attribute, to force in effect 'trustScope=Account' for every App in this customer tenancy. */ readonly accountAlwaysTrustScope: boolean; /** * One or more email domains allowed in a user's email field. If unassigned, any domain is allowed. */ readonly allowedDomains: string[]; /** * If specified, indicates the set of Urls which can be returned to after successful forgot password flow */ readonly allowedForgotPasswordFlowReturnUrls: string[]; /** * If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of \"notificationRedirectUrl\" in the POST .../admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow. */ readonly allowedNotificationRedirectUrls: string[]; readonly attributeSets?: string[]; readonly attributes?: string; /** * Audit Event retention period. If set, overrides default of 30 days after which Audit Events will be purged */ readonly auditEventRetentionPeriod: number; readonly authorization?: string; /** * Certificate Validation Config */ readonly certificateValidations: outputs.Identity.GetDomainsSettingCertificateValidation[]; /** * The attribute to store the cloud account name */ readonly cloudAccountName: string; /** * A complex attribute that specifies the Cloud Gate cross origin resource sharing settings. */ readonly cloudGateCorsSettings: outputs.Identity.GetDomainsSettingCloudGateCorsSetting[]; /** * If specified, indicates the custom SIM Migrator Url which can be used while SIM to Oracle Identity Cloud Service CloudAccount Migration. */ readonly cloudMigrationCustomUrl: string; /** * CloudAccountMigration: Enable Custom SIM Migrator Url. */ readonly cloudMigrationUrlEnabled: boolean; /** * Name of the company in different locales */ readonly companyNames: outputs.Identity.GetDomainsSettingCompanyName[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ readonly compartmentOcid: string; /** * Contact emails used to notify tenants. Can be one or more user or group alias emails. */ readonly contactEmails: string[]; /** * This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access. A value of 'none' means CSR cannot login to the services. */ readonly csrAccess: string; /** * Indicates if the branding is default or custom */ readonly customBranding: boolean; /** * Storage URL location where the sanitized custom css is located */ readonly customCssLocation: string; /** * Storage URL location where the sanitized custom html is located */ readonly customHtmlLocation: string; /** * Custom translations (JSON String) */ readonly customTranslation: string; /** * Default name of the Company in different locales */ readonly defaultCompanyNames: outputs.Identity.GetDomainsSettingDefaultCompanyName[]; /** * References to various images */ readonly defaultImages: outputs.Identity.GetDomainsSettingDefaultImage[]; /** * Default Login text in different locales */ readonly defaultLoginTexts: outputs.Identity.GetDomainsSettingDefaultLoginText[]; /** * **Deprecated Since: 18.3.6** */ readonly defaultTrustScope: string; /** * 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. */ readonly deleteInProgress: boolean; /** * The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled. */ readonly diagnosticLevel: number; /** * Controls whether DiagnosticRecords for external search-operations (against SCIM resource-types in the Admin service) identify returned resources. If true, indicates that for each successful external search-operation at least one DiagnosticRecord will include at least one identifier for each matching resource that is returned in that search-response. If false, no DiagnosticRecord should be expected to identify returned resources for a search-operation. The default value is false. */ readonly diagnosticRecordForSearchIdentifiesReturnedResources: boolean; /** * The end time up to which diagnostic recording is switched on */ readonly diagnosticTracingUpto: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ readonly domainOcid: string; /** * Indicates if Terms of Use is enabled in UI */ readonly enableTermsOfUse: boolean; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ readonly externalId: string; /** * Maximum duration for IAM User Principal Session Token expiry */ readonly iamUpstSessionExpiry: number; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ readonly id: string; /** * The User or App who created the Resource */ readonly idcsCreatedBies: outputs.Identity.GetDomainsSettingIdcsCreatedBy[]; readonly idcsEndpoint: string; /** * The User or App who modified the Resource */ readonly idcsLastModifiedBies: outputs.Identity.GetDomainsSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ readonly idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ readonly idcsPreventedOperations: string[]; /** * References to various images */ readonly images: outputs.Identity.GetDomainsSettingImage[]; /** * Indicates if 'hosted' option was selected */ readonly isHostedPage: boolean; /** * Tenant issuer. */ readonly issuer: string; /** * Locale */ readonly locale: string; /** * Login text in different locales */ readonly loginTexts: outputs.Identity.GetDomainsSettingLoginText[]; /** * Limit the maximum return of CMVA for an App */ readonly maxNoOfAppCmvaToReturn: number; /** * Limit the maximum return of members for an AppRole */ readonly maxNoOfAppRoleMembersToReturn: number; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ readonly metas: outputs.Identity.GetDomainsSettingMeta[]; /** * Database Migration Status */ readonly migrationStatus: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ readonly ocid: string; /** * On-Premises provisioning feature toggle. */ readonly onPremisesProvisioning: boolean; /** * Preferred written or spoken language used for localized user interfaces */ readonly preferredLanguage: string; /** * Previous Tenant issuer. This is an Oracle Identity Cloud Service internal attribute which is not meant to be directly modified by ID Admin. Even if the request body (Settings) contains this attribute, the actual value will be set according to the Oracle Identity Cloud Service internal logic rather than solely based on the value provided in the request payload. */ readonly prevIssuer: string; /** * Privacy Policy URL */ readonly privacyPolicyUrl: string; /** * Purge Configs for different Resource Types */ readonly purgeConfigs: outputs.Identity.GetDomainsSettingPurgeConfig[]; /** * If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use. Allowed value is \"password\". */ readonly reAuthFactors: string[]; /** * Specifies whether re-authentication is required or not when a user changes one of their security factors such as password or email. Default is true to ensure more secure behavior. */ readonly reAuthWhenChangingMyAuthenticationFactors: boolean; readonly resourceTypeSchemaVersion?: string; /** * 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. */ readonly schemas: string[]; /** * By default, a service admin can list all users in stripe. If true, a service admin cannot list other users. */ readonly serviceAdminCannotListOtherUsers: boolean; readonly settingId: string; /** * Indicates if access on SigningCert is allowed to public or not */ readonly signingCertPublicAccess: boolean; /** * **Added In:** 20.1.3 */ readonly subMappingAttr: string; /** * A list of tags on this resource. */ readonly tags: outputs.Identity.GetDomainsSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ readonly tenancyOcid: string; /** * Custom claims associated with the specific tenant */ readonly tenantCustomClaims: outputs.Identity.GetDomainsSettingTenantCustomClaim[]; /** * Terms of Use URL */ readonly termsOfUseUrl: string; /** * User's timezone */ readonly timezone: string; } /** * This data source provides details about a specific Setting resource in Oracle Cloud Infrastructure Identity Domains service. * * Get Settings * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testSetting = oci.identity.getDomainsSetting({ * idcsEndpoint: testDomain.url, * settingId: "Settings", * attributeSets: ["all"], * attributes: "", * authorization: settingAuthorization, * resourceTypeSchemaVersion: settingResourceTypeSchemaVersion, * }); * ``` */ export declare function getDomainsSettingOutput(args: GetDomainsSettingOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getDomainsSetting. */ export interface GetDomainsSettingOutputArgs { /** * 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; /** * The basic endpoint for the identity domain */ idcsEndpoint: 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; /** * ID of the resource */ settingId: pulumi.Input; } //# sourceMappingURL=getDomainsSetting.d.ts.map