Auth0

v2.14.0 published on Wednesday, Oct 26, 2022 by Pulumi

ClientGrant

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

using System.Collections.Generic;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    // The following example grants a client the "create:foo" permission (scope).
    var myClient = new Auth0.Client("myClient");

    var myResourceServer = new Auth0.ResourceServer("myResourceServer", new()
    {
        Identifier = "https://api.example.com/client-grant",
        Scopes = new[]
        {
            new Auth0.Inputs.ResourceServerScopeArgs
            {
                Value = "create:foo",
                Description = "Create foos",
            },
            new Auth0.Inputs.ResourceServerScopeArgs
            {
                Value = "create:bar",
                Description = "Create bars",
            },
        },
    });

    var myClientGrant = new Auth0.ClientGrant("myClientGrant", new()
    {
        ClientId = myClient.Id,
        Audience = myResourceServer.Identifier,
        Scopes = new[]
        {
            "create:foo",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myClient, err := auth0.NewClient(ctx, "myClient", nil)
		if err != nil {
			return err
		}
		myResourceServer, err := auth0.NewResourceServer(ctx, "myResourceServer", &auth0.ResourceServerArgs{
			Identifier: pulumi.String("https://api.example.com/client-grant"),
			Scopes: ResourceServerScopeArray{
				&ResourceServerScopeArgs{
					Value:       pulumi.String("create:foo"),
					Description: pulumi.String("Create foos"),
				},
				&ResourceServerScopeArgs{
					Value:       pulumi.String("create:bar"),
					Description: pulumi.String("Create bars"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = auth0.NewClientGrant(ctx, "myClientGrant", &auth0.ClientGrantArgs{
			ClientId: myClient.ID(),
			Audience: myResourceServer.Identifier,
			Scopes: pulumi.StringArray{
				pulumi.String("create:foo"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Client;
import com.pulumi.auth0.ResourceServer;
import com.pulumi.auth0.ResourceServerArgs;
import com.pulumi.auth0.inputs.ResourceServerScopeArgs;
import com.pulumi.auth0.ClientGrant;
import com.pulumi.auth0.ClientGrantArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myClient = new Client("myClient");

        var myResourceServer = new ResourceServer("myResourceServer", ResourceServerArgs.builder()        
            .identifier("https://api.example.com/client-grant")
            .scopes(            
                ResourceServerScopeArgs.builder()
                    .value("create:foo")
                    .description("Create foos")
                    .build(),
                ResourceServerScopeArgs.builder()
                    .value("create:bar")
                    .description("Create bars")
                    .build())
            .build());

        var myClientGrant = new ClientGrant("myClientGrant", ClientGrantArgs.builder()        
            .clientId(myClient.id())
            .audience(myResourceServer.identifier())
            .scopes("create:foo")
            .build());

    }
}
import pulumi
import pulumi_auth0 as auth0

# The following example grants a client the "create:foo" permission (scope).
my_client = auth0.Client("myClient")
my_resource_server = auth0.ResourceServer("myResourceServer",
    identifier="https://api.example.com/client-grant",
    scopes=[
        auth0.ResourceServerScopeArgs(
            value="create:foo",
            description="Create foos",
        ),
        auth0.ResourceServerScopeArgs(
            value="create:bar",
            description="Create bars",
        ),
    ])
my_client_grant = auth0.ClientGrant("myClientGrant",
    client_id=my_client.id,
    audience=my_resource_server.identifier,
    scopes=["create:foo"])
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

// The following example grants a client the "create:foo" permission (scope).
const myClient = new auth0.Client("myClient", {});
const myResourceServer = new auth0.ResourceServer("myResourceServer", {
    identifier: "https://api.example.com/client-grant",
    scopes: [
        {
            value: "create:foo",
            description: "Create foos",
        },
        {
            value: "create:bar",
            description: "Create bars",
        },
    ],
});
const myClientGrant = new auth0.ClientGrant("myClientGrant", {
    clientId: myClient.id,
    audience: myResourceServer.identifier,
    scopes: ["create:foo"],
});
resources:
  # The following example grants a client the "create:foo" permission (scope).
  myClient:
    type: auth0:Client
  myResourceServer:
    type: auth0:ResourceServer
    properties:
      identifier: https://api.example.com/client-grant
      scopes:
        - value: create:foo
          description: Create foos
        - value: create:bar
          description: Create bars
  myClientGrant:
    type: auth0:ClientGrant
    properties:
      clientId: ${myClient.id}
      audience: ${myResourceServer.identifier}
      scopes:
        - create:foo

Create ClientGrant Resource

new ClientGrant(name: string, args: ClientGrantArgs, opts?: CustomResourceOptions);
@overload
def ClientGrant(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                audience: Optional[str] = None,
                client_id: Optional[str] = None,
                scopes: Optional[Sequence[str]] = None)
@overload
def ClientGrant(resource_name: str,
                args: ClientGrantArgs,
                opts: Optional[ResourceOptions] = 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.

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.

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:

Audience string

Audience or API Identifier for this grant.

ClientId string

ID of the client for this grant.

Scopes List<string>

Permissions (scopes) included in this grant.

Audience string

Audience or API Identifier for this grant.

ClientId string

ID of the client for this grant.

Scopes []string

Permissions (scopes) included in this grant.

audience String

Audience or API Identifier for this grant.

clientId String

ID of the client for this grant.

scopes List<String>

Permissions (scopes) included in this grant.

audience string

Audience or API Identifier for this grant.

clientId string

ID of the client for this grant.

scopes string[]

Permissions (scopes) included in this grant.

audience str

Audience or API Identifier for this grant.

client_id str

ID of the client for this grant.

scopes Sequence[str]

Permissions (scopes) included in this grant.

audience String

Audience or API Identifier for this grant.

clientId String

ID of the client for this grant.

scopes List<String>

Permissions (scopes) included in this grant.

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) -> ClientGrant
func 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.
The following state arguments are supported:
Audience string

Audience or API Identifier for this grant.

ClientId string

ID of the client for this grant.

Scopes List<string>

Permissions (scopes) included in this grant.

Audience string

Audience or API Identifier for this grant.

ClientId string

ID of the client for this grant.

Scopes []string

Permissions (scopes) included in this grant.

audience String

Audience or API Identifier for this grant.

clientId String

ID of the client for this grant.

scopes List<String>

Permissions (scopes) included in this grant.

audience string

Audience or API Identifier for this grant.

clientId string

ID of the client for this grant.

scopes string[]

Permissions (scopes) included in this grant.

audience str

Audience or API Identifier for this grant.

client_id str

ID of the client for this grant.

scopes Sequence[str]

Permissions (scopes) included in this grant.

audience String

Audience or API Identifier for this grant.

clientId String

ID of the client for this grant.

scopes List<String>

Permissions (scopes) included in this grant.

Import

Client grants can be imported using the grant ID. # Application -> APIs -> Expand the required API # Example

 $ pulumi import auth0:index/clientGrant:ClientGrant my_client_grant cgr_XXXXXXXXXXXXXXXX

Package Details

Repository
https://github.com/pulumi/pulumi-auth0
License
Apache-2.0
Notes

This Pulumi package is based on the auth0 Terraform Provider.