auth0.OrganizationDiscoveryDomain
Manage organization discovery domains for Home Realm Discovery. These domains help automatically route users to the correct organization based on their email domain.
Create OrganizationDiscoveryDomain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrganizationDiscoveryDomain(name: string, args: OrganizationDiscoveryDomainArgs, opts?: CustomResourceOptions);@overload
def OrganizationDiscoveryDomain(resource_name: str,
args: OrganizationDiscoveryDomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrganizationDiscoveryDomain(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain: Optional[str] = None,
organization_id: Optional[str] = None,
status: Optional[str] = None)func NewOrganizationDiscoveryDomain(ctx *Context, name string, args OrganizationDiscoveryDomainArgs, opts ...ResourceOption) (*OrganizationDiscoveryDomain, error)public OrganizationDiscoveryDomain(string name, OrganizationDiscoveryDomainArgs args, CustomResourceOptions? opts = null)
public OrganizationDiscoveryDomain(String name, OrganizationDiscoveryDomainArgs args)
public OrganizationDiscoveryDomain(String name, OrganizationDiscoveryDomainArgs args, CustomResourceOptions options)
type: auth0:OrganizationDiscoveryDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrganizationDiscoveryDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OrganizationDiscoveryDomainArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrganizationDiscoveryDomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationDiscoveryDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationDiscoveryDomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var organizationDiscoveryDomainResource = new Auth0.OrganizationDiscoveryDomain("organizationDiscoveryDomainResource", new()
{
Domain = "string",
OrganizationId = "string",
Status = "string",
});
example, err := auth0.NewOrganizationDiscoveryDomain(ctx, "organizationDiscoveryDomainResource", &auth0.OrganizationDiscoveryDomainArgs{
Domain: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
Status: pulumi.String("string"),
})
var organizationDiscoveryDomainResource = new OrganizationDiscoveryDomain("organizationDiscoveryDomainResource", OrganizationDiscoveryDomainArgs.builder()
.domain("string")
.organizationId("string")
.status("string")
.build());
organization_discovery_domain_resource = auth0.OrganizationDiscoveryDomain("organizationDiscoveryDomainResource",
domain="string",
organization_id="string",
status="string")
const organizationDiscoveryDomainResource = new auth0.OrganizationDiscoveryDomain("organizationDiscoveryDomainResource", {
domain: "string",
organizationId: "string",
status: "string",
});
type: auth0:OrganizationDiscoveryDomain
properties:
domain: string
organizationId: string
status: string
OrganizationDiscoveryDomain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OrganizationDiscoveryDomain resource accepts the following input properties:
- Domain string
- The domain name for organization discovery.
- Organization
Id string - The ID of the organization.
- Status string
- Verification status. Must be either 'pending' or 'verified'.
- Domain string
- The domain name for organization discovery.
- Organization
Id string - The ID of the organization.
- Status string
- Verification status. Must be either 'pending' or 'verified'.
- domain String
- The domain name for organization discovery.
- organization
Id String - The ID of the organization.
- status String
- Verification status. Must be either 'pending' or 'verified'.
- domain string
- The domain name for organization discovery.
- organization
Id string - The ID of the organization.
- status string
- Verification status. Must be either 'pending' or 'verified'.
- domain str
- The domain name for organization discovery.
- organization_
id str - The ID of the organization.
- status str
- Verification status. Must be either 'pending' or 'verified'.
- domain String
- The domain name for organization discovery.
- organization
Id String - The ID of the organization.
- status String
- Verification status. Must be either 'pending' or 'verified'.
Outputs
All input properties are implicitly available as output properties. Additionally, the OrganizationDiscoveryDomain resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Verification
Host string - The full domain where the TXT record should be added.
- Verification
Txt string - TXT record value for domain verification.
- Id string
- The provider-assigned unique ID for this managed resource.
- Verification
Host string - The full domain where the TXT record should be added.
- Verification
Txt string - TXT record value for domain verification.
- id String
- The provider-assigned unique ID for this managed resource.
- verification
Host String - The full domain where the TXT record should be added.
- verification
Txt String - TXT record value for domain verification.
- id string
- The provider-assigned unique ID for this managed resource.
- verification
Host string - The full domain where the TXT record should be added.
- verification
Txt string - TXT record value for domain verification.
- id str
- The provider-assigned unique ID for this managed resource.
- verification_
host str - The full domain where the TXT record should be added.
- verification_
txt str - TXT record value for domain verification.
- id String
- The provider-assigned unique ID for this managed resource.
- verification
Host String - The full domain where the TXT record should be added.
- verification
Txt String - TXT record value for domain verification.
Look up Existing OrganizationDiscoveryDomain Resource
Get an existing OrganizationDiscoveryDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OrganizationDiscoveryDomainState, opts?: CustomResourceOptions): OrganizationDiscoveryDomain@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
domain: Optional[str] = None,
organization_id: Optional[str] = None,
status: Optional[str] = None,
verification_host: Optional[str] = None,
verification_txt: Optional[str] = None) -> OrganizationDiscoveryDomainfunc GetOrganizationDiscoveryDomain(ctx *Context, name string, id IDInput, state *OrganizationDiscoveryDomainState, opts ...ResourceOption) (*OrganizationDiscoveryDomain, error)public static OrganizationDiscoveryDomain Get(string name, Input<string> id, OrganizationDiscoveryDomainState? state, CustomResourceOptions? opts = null)public static OrganizationDiscoveryDomain get(String name, Output<String> id, OrganizationDiscoveryDomainState state, CustomResourceOptions options)resources: _: type: auth0:OrganizationDiscoveryDomain get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Domain string
- The domain name for organization discovery.
- Organization
Id string - The ID of the organization.
- Status string
- Verification status. Must be either 'pending' or 'verified'.
- Verification
Host string - The full domain where the TXT record should be added.
- Verification
Txt string - TXT record value for domain verification.
- Domain string
- The domain name for organization discovery.
- Organization
Id string - The ID of the organization.
- Status string
- Verification status. Must be either 'pending' or 'verified'.
- Verification
Host string - The full domain where the TXT record should be added.
- Verification
Txt string - TXT record value for domain verification.
- domain String
- The domain name for organization discovery.
- organization
Id String - The ID of the organization.
- status String
- Verification status. Must be either 'pending' or 'verified'.
- verification
Host String - The full domain where the TXT record should be added.
- verification
Txt String - TXT record value for domain verification.
- domain string
- The domain name for organization discovery.
- organization
Id string - The ID of the organization.
- status string
- Verification status. Must be either 'pending' or 'verified'.
- verification
Host string - The full domain where the TXT record should be added.
- verification
Txt string - TXT record value for domain verification.
- domain str
- The domain name for organization discovery.
- organization_
id str - The ID of the organization.
- status str
- Verification status. Must be either 'pending' or 'verified'.
- verification_
host str - The full domain where the TXT record should be added.
- verification_
txt str - TXT record value for domain verification.
- domain String
- The domain name for organization discovery.
- organization
Id String - The ID of the organization.
- status String
- Verification status. Must be either 'pending' or 'verified'.
- verification
Host String - The full domain where the TXT record should be added.
- verification
Txt String - TXT record value for domain verification.
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0Terraform Provider.
