Docs
PackagesAuth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
auth0.ClientGrant
Explore with Pulumi AI
Auth0 uses various grant types, or methods by which you grant limited access to your resources to another entity without exposing credentials. The OAuth 2.0 protocol supports several types of grants, which allow different types of access. This resource allows you to create and manage client grants used with configured Auth0 clients.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
# The following example grants a client the "create:foo" and "create:bar" permissions (scopes).
myClient:
type: auth0:Client
name: my_client
properties:
name: Example Application - Client Grant (Managed by Terraform)
myResourceServer:
type: auth0:ResourceServer
name: my_resource_server
properties:
name: Example Resource Server - Client Grant (Managed by Terraform)
identifier: https://api.example.com/client-grant
scopes:
- value: create:foo
description: Create foos
- value: create:bar
description: Create bars
myClientGrant:
type: auth0:ClientGrant
name: my_client_grant
properties:
clientId: ${myClient.id}
audience: ${myResourceServer.identifier}
scopes:
- create:foo
- create:bar
Create ClientGrant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientGrant(name: string, args: ClientGrantArgs, opts?: CustomResourceOptions);@overload
def ClientGrant(resource_name: str,
args: ClientGrantArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientGrant(resource_name: str,
opts: Optional[ResourceOptions] = None,
audience: Optional[str] = None,
client_id: Optional[str] = None,
scopes: Optional[Sequence[str]] = None)func NewClientGrant(ctx *Context, name string, args ClientGrantArgs, opts ...ResourceOption) (*ClientGrant, error)public ClientGrant(string name, ClientGrantArgs args, CustomResourceOptions? opts = null)
public ClientGrant(String name, ClientGrantArgs args)
public ClientGrant(String name, ClientGrantArgs args, CustomResourceOptions options)
type: auth0:ClientGrant
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 ClientGrantArgs
- 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 ClientGrantArgs
- 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 ClientGrantArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientGrantArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientGrantArgs
- 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 clientGrantResource = new Auth0.ClientGrant("clientGrantResource", new()
{
Audience = "string",
ClientId = "string",
Scopes = new[]
{
"string",
},
});
example, err := auth0.NewClientGrant(ctx, "clientGrantResource", &auth0.ClientGrantArgs{
Audience: pulumi.String("string"),
ClientId: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
})
var clientGrantResource = new ClientGrant("clientGrantResource", ClientGrantArgs.builder()
.audience("string")
.clientId("string")
.scopes("string")
.build());
client_grant_resource = auth0.ClientGrant("clientGrantResource",
audience="string",
client_id="string",
scopes=["string"])
const clientGrantResource = new auth0.ClientGrant("clientGrantResource", {
audience: "string",
clientId: "string",
scopes: ["string"],
});
type: auth0:ClientGrant
properties:
audience: string
clientId: string
scopes:
- string
ClientGrant Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ClientGrant resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientGrant 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 ClientGrant Resource
Get an existing ClientGrant 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?: ClientGrantState, opts?: CustomResourceOptions): ClientGrant@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
audience: Optional[str] = None,
client_id: Optional[str] = None,
scopes: Optional[Sequence[str]] = None) -> ClientGrantfunc GetClientGrant(ctx *Context, name string, id IDInput, state *ClientGrantState, opts ...ResourceOption) (*ClientGrant, error)public static ClientGrant Get(string name, Input<string> id, ClientGrantState? state, CustomResourceOptions? opts = null)public static ClientGrant get(String name, Output<String> id, ClientGrantState 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.
Import
This resource can be imported by specifying the client grant ID.
You can find this within the Management Dashboard in Application -> APIs -> Expand the required API.
Example:
$ pulumi import auth0:index/clientGrant:ClientGrant my_client_grant "cgr_XXXXXXXXXXXXXXXX"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0Terraform Provider.