Data Source: oci_identity_domains_cloud_gate

This data source provides details about a specific Cloud Gate resource in Oracle Cloud Infrastructure Identity Domains service.

Get a Cloud Gate

Example Usage

data "oci_identity_domains_cloud_gate" "test_cloud_gate" {
	#Required
	cloud_gate_id = oci_identity_domains_cloud_gate.test_cloud_gate.id
	idcs_endpoint = data.oci_identity_domain.test_domain.url

	#Optional
	attribute_sets = ["all"]
	attributes = ""
	authorization = var.cloud_gate_authorization
	resource_type_schema_version = var.cloud_gate_resource_type_schema_version
}

Argument Reference

The following arguments are supported:

attribute_sets - (Optional) 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.
attributes - (Optional) 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.
authorization - (Optional) The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
cloud_gate_id - (Required) ID of the resource
idcs_endpoint - (Required) The basic endpoint for the identity domain
resource_type_schema_version - (Optional) 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.

Attributes Reference

The following attributes are exported:

active - Activation status for this Cloud Gate

Added In: 19.2.1

SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
compartment_ocid - 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
delete_in_progress - 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
description - Brief description for this Cloud Gate

Added In: 19.2.1

SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
display_name - Display name/Host identifier for this Cloud Gate

Added In: 19.2.1

SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: server
domain_ocid - 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
id - 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.

SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: global
idcs_created_by - The User or App who created the Resource

SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
- ref - The URI of the SCIM resource that represents the User or App who created this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: reference
  - uniqueness: none
- display - The displayName of the User or App who created this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- ocid - The OCID of the SCIM resource that represents the User or App who created this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - returned: default
  - type: string
  - uniqueness: none
- type - The type of resource, User or App, that created this Resource
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- value - The ID of the SCIM resource that represents the User or App who created this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
idcs_last_modified_by - The User or App who modified the Resource

SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
- ref - The URI of the SCIM resource that represents the User or App who modified this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: reference
  - uniqueness: none
- display - The displayName of the User or App who modified this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- ocid - The OCID of the SCIM resource that represents the User or App who modified this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - returned: default
  - type: string
  - uniqueness: none
- type - The type of resource, User or App, that modified this Resource
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- value - The ID of the SCIM resource that represents the User or App who modified this Resource
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
idcs_last_upgraded_in_release - 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
idcs_prevented_operations - 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
is_opc_service - Indicates whether this resource was created by OPC

Added In: 19.3.3

SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: boolean
- uniqueness: none
last_modified_time - Last updated timestamp for this CloudGate’s servers and mappings.

Added In: 19.2.1

SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: dateTime
- uniqueness: none
mappings - A list of Cloud Gate Mappings that map Apps to this Cloud Gate

SCIM++ Properties:
- caseExact: true
- idcsCompositeKey: [serverId, resourcePrefix]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
- ref - URI of the App being mapped to
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: reference
  - uniqueness: none
- app_id - The ID of the App being mapped to
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- mapping_id - The id of the Cloud Gate Mapping
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- name - The name (Client ID) of the App being mapped to
  
  Added In: 19.2.1
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- nginx_settings - More NGINX Settings. JSON encoded key value pairs similar to WTP encoding
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- policy_name - The Web Tier policy name used for the App that is mapped to this Cloud Gate
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- proxy_pass - NGINX ProxyPass entry for this Mapping
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- resource_prefix - Resource prefix for this mapping. This will be used to define the location block
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
- server_id - Server Instance for the Mapping. This is one of the server IDs(server blocks) from the associated Cloud Gate list
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
- upstream_server_group_id - Upstream server group instance for the Mapping. This is one of the upstream server group IDs(upstream blocks) from the associated Cloud Gate list
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- value - The id of the App being mapped to
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
meta - 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
- created - The DateTime the Resource was added to the Service Provider
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: dateTime
  - uniqueness: none
- last_modified - The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: dateTime
  - uniqueness: none
- location - The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- resource_type - Name of the resource type of the resource–for example, Users or Groups
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- version - The version of the Resource being returned. This value must be the same as the ETag HTTP response header.
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
oauth_client - A reference to the OAuth client App used by this Cloud Gate instance.

SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
- uniqueness: none
- ref - The URI of the OAuth app for this CloudGate.
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: reference
  - uniqueness: none
- client_id - The Client ID of the OAuth app for this CloudGate.
  
  Added In: 19.2.1
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- value - The id of the OAuth app for this CloudGate.
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
ocid - 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
schemas - 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
servers - A list of Server Blocks on this Cloud Gate

SCIM++ Properties:
- caseExact: true
- idcsCompositeKey: [hostName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
- host_name - Hostname for the Server block
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
- nginx_settings - More nginx Settings. JSON encoded text block
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- port - Port for the Server Block
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: integer
  - uniqueness: none
- server_id - Server Name for the Server Block
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- ssl - SSL flag for the Server Block
  
  SCIM++ Properties:
  - caseExact: true
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: boolean
  - uniqueness: none
tags - 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
- key - Key or name of the tag.
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: true
  - multiValued: false
  - mutability: readWrite
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
- value - Value of the tag.
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: true
  - multiValued: false
  - mutability: readWrite
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
tenancy_ocid - 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
type - Type of Cloud Gate

SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: string
- uniqueness: none
upstream_server_groups - A list of upstream server groups

Added In: 20.1.3

SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
- ref - URI of the upstream server groups
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: reference
  - uniqueness: none
- display_name - Display name of upstream
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
- nginx_settings - Any additional settings in nginx configuration form
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- ssl - SSL flag for the Upstream Block
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: boolean
  - uniqueness: none
- value - Name for the Upstream Block
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none
upstream_servers - A list of upstream servers

Added In: 20.1.3

SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
- ref - URI of the upstream server
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: reference
  - uniqueness: none
- display_name - Display name of upstream server
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- group_id - Upstream Server Group instance for the upstream server. This is one of the upstreamServerGroup IDs(upstream blocks) from the associated Cloud Gate list
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- host_name - Any incoming request to cloud gate is finally sent to this host, if selected during load balancing
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- nginx_settings - Any additional settings for this upstream server in nginx configuration form
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: string
  - uniqueness: none
- port - Port for the Upstream Server
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: false
  - multiValued: false
  - mutability: readOnly
  - required: false
  - returned: default
  - type: integer
  - uniqueness: none
- value - ID of the upstream server
  
  Added In: 20.1.3
  
  SCIM++ Properties:
  - caseExact: false
  - idcsSearchable: true
  - multiValued: false
  - mutability: readOnly
  - required: true
  - returned: default
  - type: string
  - uniqueness: none