Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. OrganizationClientGrant
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.OrganizationClientGrant

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

    With this resource, you can manage a client grant associated with an organization.

    Create OrganizationClientGrant Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationClientGrant(name: string, args: OrganizationClientGrantArgs, opts?: CustomResourceOptions);
    @overload
def OrganizationClientGrant(resource_name: str,
                            args: OrganizationClientGrantArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def OrganizationClientGrant(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            grant_id: Optional[str] = None,
                            organization_id: Optional[str] = None)
    func NewOrganizationClientGrant(ctx *Context, name string, args OrganizationClientGrantArgs, opts ...ResourceOption) (*OrganizationClientGrant, error)
    public OrganizationClientGrant(string name, OrganizationClientGrantArgs args, CustomResourceOptions? opts = null)
    public OrganizationClientGrant(String name, OrganizationClientGrantArgs args)
public OrganizationClientGrant(String name, OrganizationClientGrantArgs args, CustomResourceOptions options)

    type: auth0:OrganizationClientGrant
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 OrganizationClientGrantArgs
    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 OrganizationClientGrantArgs
    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 OrganizationClientGrantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationClientGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationClientGrantArgs
    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 organizationClientGrantResource = new Auth0.OrganizationClientGrant("organizationClientGrantResource", new()
{
    GrantId = "string",
    OrganizationId = "string",
});

    example, err := auth0.NewOrganizationClientGrant(ctx, "organizationClientGrantResource", &auth0.OrganizationClientGrantArgs{
	GrantId:        pulumi.String("string"),
	OrganizationId: pulumi.String("string"),
})

    var organizationClientGrantResource = new OrganizationClientGrant("organizationClientGrantResource", OrganizationClientGrantArgs.builder()
    .grantId("string")
    .organizationId("string")
    .build());

    organization_client_grant_resource = auth0.OrganizationClientGrant("organizationClientGrantResource",
    grant_id="string",
    organization_id="string")

    const organizationClientGrantResource = new auth0.OrganizationClientGrant("organizationClientGrantResource", {
    grantId: "string",
    organizationId: "string",
});

    type: auth0:OrganizationClientGrant
properties:
    grantId: string
    organizationId: string

    OrganizationClientGrant 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 OrganizationClientGrant resource accepts the following input properties:

    GrantId string
    A Client Grant ID to add to the organization.
    OrganizationId string
    The ID of the organization to associate the client grant.
    GrantId string
    A Client Grant ID to add to the organization.
    OrganizationId string
    The ID of the organization to associate the client grant.
    grantId String
    A Client Grant ID to add to the organization.
    organizationId String
    The ID of the organization to associate the client grant.
    grantId string
    A Client Grant ID to add to the organization.
    organizationId string
    The ID of the organization to associate the client grant.
    grant_id str
    A Client Grant ID to add to the organization.
    organization_id str
    The ID of the organization to associate the client grant.
    grantId String
    A Client Grant ID to add to the organization.
    organizationId String
    The ID of the organization to associate the client grant.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationClientGrant resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OrganizationClientGrant Resource

    Get an existing OrganizationClientGrant 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?: OrganizationClientGrantState, opts?: CustomResourceOptions): OrganizationClientGrant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        grant_id: Optional[str] = None,
        organization_id: Optional[str] = None) -> OrganizationClientGrant
    func GetOrganizationClientGrant(ctx *Context, name string, id IDInput, state *OrganizationClientGrantState, opts ...ResourceOption) (*OrganizationClientGrant, error)
    public static OrganizationClientGrant Get(string name, Input<string> id, OrganizationClientGrantState? state, CustomResourceOptions? opts = null)
    public static OrganizationClientGrant get(String name, Output<String> id, OrganizationClientGrantState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    GrantId string
    A Client Grant ID to add to the organization.
    OrganizationId string
    The ID of the organization to associate the client grant.
    GrantId string
    A Client Grant ID to add to the organization.
    OrganizationId string
    The ID of the organization to associate the client grant.
    grantId String
    A Client Grant ID to add to the organization.
    organizationId String
    The ID of the organization to associate the client grant.
    grantId string
    A Client Grant ID to add to the organization.
    organizationId string
    The ID of the organization to associate the client grant.
    grant_id str
    A Client Grant ID to add to the organization.
    organization_id str
    The ID of the organization to associate the client grant.
    grantId String
    A Client Grant ID to add to the organization.
    organizationId String
    The ID of the organization to associate the client grant.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0