import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Branding Setting resource in Oracle Cloud Infrastructure Identity Domains service. * * Get Branding Settings * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBrandingSetting = oci.identity.getDomainsBrandingSetting({ * brandingSettingId: "BrandingSettings", * idcsEndpoint: testDomain.url, * attributeSets: ["all"], * attributes: "", * authorization: brandingSettingAuthorization, * resourceTypeSchemaVersion: brandingSettingResourceTypeSchemaVersion, * }); * ``` */ export declare function getDomainsBrandingSetting(args: GetDomainsBrandingSettingArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getDomainsBrandingSetting. */ export interface GetDomainsBrandingSettingArgs { /** * 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; /** * ID of the resource */ brandingSettingId: 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; } /** * A collection of values returned by getDomainsBrandingSetting. */ export interface GetDomainsBrandingSettingResult { readonly attributeSets?: string[]; readonly attributes?: string; readonly authorization?: string; readonly brandingSettingId: string; /** * Name of the company in different locales */ readonly companyNames: outputs.Identity.GetDomainsBrandingSettingCompanyName[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ readonly compartmentOcid: string; /** * Indicates if the branding is default or is custom branding */ 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.GetDomainsBrandingSettingDefaultCompanyName[]; /** * References to various images */ readonly defaultImages: outputs.Identity.GetDomainsBrandingSettingDefaultImage[]; /** * Default Login text in different locales */ readonly defaultLoginTexts: outputs.Identity.GetDomainsBrandingSettingDefaultLoginText[]; /** * 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; /** * 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; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * The User or App who created the Resource */ readonly idcsCreatedBies: outputs.Identity.GetDomainsBrandingSettingIdcsCreatedBy[]; readonly idcsEndpoint: string; /** * The User or App who modified the Resource */ readonly idcsLastModifiedBies: outputs.Identity.GetDomainsBrandingSettingIdcsLastModifiedBy[]; /** * 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.GetDomainsBrandingSettingImage[]; /** * Indicates if 'hosted' option was selected */ readonly isHostedPage: boolean; /** * Locale */ readonly locale: string; /** * Login text in different locales */ readonly loginTexts: outputs.Identity.GetDomainsBrandingSettingLoginText[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ readonly metas: outputs.Identity.GetDomainsBrandingSettingMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ readonly ocid: string; /** * Preferred written or spoken language used for localized user interfaces */ readonly preferredLanguage: string; /** * Privacy Policy URL */ readonly privacyPolicyUrl: string; 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[]; /** * A list of tags on this resource. */ readonly tags: outputs.Identity.GetDomainsBrandingSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ readonly tenancyOcid: string; /** * Terms of Use URL */ readonly termsOfUseUrl: string; /** * User's timezone */ readonly timezone: string; } /** * This data source provides details about a specific Branding Setting resource in Oracle Cloud Infrastructure Identity Domains service. * * Get Branding Settings * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBrandingSetting = oci.identity.getDomainsBrandingSetting({ * brandingSettingId: "BrandingSettings", * idcsEndpoint: testDomain.url, * attributeSets: ["all"], * attributes: "", * authorization: brandingSettingAuthorization, * resourceTypeSchemaVersion: brandingSettingResourceTypeSchemaVersion, * }); * ``` */ export declare function getDomainsBrandingSettingOutput(args: GetDomainsBrandingSettingOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getDomainsBrandingSetting. */ export interface GetDomainsBrandingSettingOutputArgs { /** * 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; /** * ID of the resource */ brandingSettingId: 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; } //# sourceMappingURL=getDomainsBrandingSetting.d.ts.map