Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";
// Create an Agent connector
const agent = new authentik.EndpointsConnectorAgent("agent", {name: "agent"});
const token = new authentik.EndpointsConnectorAgentEnrollmentToken("token", {
connector: agent.endpointsConnectorAgentId,
name: "my-enrollment token",
expiring: false,
retrieveKey: true,
});
import pulumi
import pulumi_authentik as authentik
# Create an Agent connector
agent = authentik.EndpointsConnectorAgent("agent", name="agent")
token = authentik.EndpointsConnectorAgentEnrollmentToken("token",
connector=agent.endpoints_connector_agent_id,
name="my-enrollment token",
expiring=False,
retrieve_key=True)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Create an Agent connector
agent, err := authentik.NewEndpointsConnectorAgent(ctx, "agent", &authentik.EndpointsConnectorAgentArgs{
Name: pulumi.String("agent"),
})
if err != nil {
return err
}
_, err = authentik.NewEndpointsConnectorAgentEnrollmentToken(ctx, "token", &authentik.EndpointsConnectorAgentEnrollmentTokenArgs{
Connector: agent.EndpointsConnectorAgentId,
Name: pulumi.String("my-enrollment token"),
Expiring: pulumi.Bool(false),
RetrieveKey: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;
return await Deployment.RunAsync(() =>
{
// Create an Agent connector
var agent = new Authentik.EndpointsConnectorAgent("agent", new()
{
Name = "agent",
});
var token = new Authentik.EndpointsConnectorAgentEnrollmentToken("token", new()
{
Connector = agent.EndpointsConnectorAgentId,
Name = "my-enrollment token",
Expiring = false,
RetrieveKey = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.EndpointsConnectorAgent;
import com.pulumi.authentik.EndpointsConnectorAgentArgs;
import com.pulumi.authentik.EndpointsConnectorAgentEnrollmentToken;
import com.pulumi.authentik.EndpointsConnectorAgentEnrollmentTokenArgs;
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) {
// Create an Agent connector
var agent = new EndpointsConnectorAgent("agent", EndpointsConnectorAgentArgs.builder()
.name("agent")
.build());
var token = new EndpointsConnectorAgentEnrollmentToken("token", EndpointsConnectorAgentEnrollmentTokenArgs.builder()
.connector(agent.endpointsConnectorAgentId())
.name("my-enrollment token")
.expiring(false)
.retrieveKey(true)
.build());
}
}
resources:
# Create an Agent connector
agent:
type: authentik:EndpointsConnectorAgent
properties:
name: agent
token:
type: authentik:EndpointsConnectorAgentEnrollmentToken
properties:
connector: ${agent.endpointsConnectorAgentId}
name: my-enrollment token
expiring: false
retrieveKey: true
Create EndpointsConnectorAgentEnrollmentToken Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EndpointsConnectorAgentEnrollmentToken(name: string, args: EndpointsConnectorAgentEnrollmentTokenArgs, opts?: CustomResourceOptions);@overload
def EndpointsConnectorAgentEnrollmentToken(resource_name: str,
args: EndpointsConnectorAgentEnrollmentTokenArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EndpointsConnectorAgentEnrollmentToken(resource_name: str,
opts: Optional[ResourceOptions] = None,
connector: Optional[str] = None,
device_access_group: Optional[str] = None,
endpoints_connector_agent_enrollment_token_id: Optional[str] = None,
expires: Optional[str] = None,
expiring: Optional[bool] = None,
name: Optional[str] = None,
retrieve_key: Optional[bool] = None)func NewEndpointsConnectorAgentEnrollmentToken(ctx *Context, name string, args EndpointsConnectorAgentEnrollmentTokenArgs, opts ...ResourceOption) (*EndpointsConnectorAgentEnrollmentToken, error)public EndpointsConnectorAgentEnrollmentToken(string name, EndpointsConnectorAgentEnrollmentTokenArgs args, CustomResourceOptions? opts = null)
public EndpointsConnectorAgentEnrollmentToken(String name, EndpointsConnectorAgentEnrollmentTokenArgs args)
public EndpointsConnectorAgentEnrollmentToken(String name, EndpointsConnectorAgentEnrollmentTokenArgs args, CustomResourceOptions options)
type: authentik:EndpointsConnectorAgentEnrollmentToken
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 EndpointsConnectorAgentEnrollmentTokenArgs
- 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 EndpointsConnectorAgentEnrollmentTokenArgs
- 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 EndpointsConnectorAgentEnrollmentTokenArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EndpointsConnectorAgentEnrollmentTokenArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EndpointsConnectorAgentEnrollmentTokenArgs
- 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 endpointsConnectorAgentEnrollmentTokenResource = new Authentik.EndpointsConnectorAgentEnrollmentToken("endpointsConnectorAgentEnrollmentTokenResource", new()
{
Connector = "string",
DeviceAccessGroup = "string",
EndpointsConnectorAgentEnrollmentTokenId = "string",
Expires = "string",
Expiring = false,
Name = "string",
RetrieveKey = false,
});
example, err := authentik.NewEndpointsConnectorAgentEnrollmentToken(ctx, "endpointsConnectorAgentEnrollmentTokenResource", &authentik.EndpointsConnectorAgentEnrollmentTokenArgs{
Connector: pulumi.String("string"),
DeviceAccessGroup: pulumi.String("string"),
EndpointsConnectorAgentEnrollmentTokenId: pulumi.String("string"),
Expires: pulumi.String("string"),
Expiring: pulumi.Bool(false),
Name: pulumi.String("string"),
RetrieveKey: pulumi.Bool(false),
})
var endpointsConnectorAgentEnrollmentTokenResource = new EndpointsConnectorAgentEnrollmentToken("endpointsConnectorAgentEnrollmentTokenResource", EndpointsConnectorAgentEnrollmentTokenArgs.builder()
.connector("string")
.deviceAccessGroup("string")
.endpointsConnectorAgentEnrollmentTokenId("string")
.expires("string")
.expiring(false)
.name("string")
.retrieveKey(false)
.build());
endpoints_connector_agent_enrollment_token_resource = authentik.EndpointsConnectorAgentEnrollmentToken("endpointsConnectorAgentEnrollmentTokenResource",
connector="string",
device_access_group="string",
endpoints_connector_agent_enrollment_token_id="string",
expires="string",
expiring=False,
name="string",
retrieve_key=False)
const endpointsConnectorAgentEnrollmentTokenResource = new authentik.EndpointsConnectorAgentEnrollmentToken("endpointsConnectorAgentEnrollmentTokenResource", {
connector: "string",
deviceAccessGroup: "string",
endpointsConnectorAgentEnrollmentTokenId: "string",
expires: "string",
expiring: false,
name: "string",
retrieveKey: false,
});
type: authentik:EndpointsConnectorAgentEnrollmentToken
properties:
connector: string
deviceAccessGroup: string
endpointsConnectorAgentEnrollmentTokenId: string
expires: string
expiring: false
name: string
retrieveKey: false
EndpointsConnectorAgentEnrollmentToken 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 EndpointsConnectorAgentEnrollmentToken resource accepts the following input properties:
- Connector string
- Device
Access stringGroup - Endpoints
Connector stringAgent Enrollment Token Id - The ID of this resource.
- Expires string
- Expiring bool
- Defaults to
true. - Name string
- Retrieve
Key bool - Defaults to
false.
- Connector string
- Device
Access stringGroup - Endpoints
Connector stringAgent Enrollment Token Id - The ID of this resource.
- Expires string
- Expiring bool
- Defaults to
true. - Name string
- Retrieve
Key bool - Defaults to
false.
- connector String
- device
Access StringGroup - endpoints
Connector StringAgent Enrollment Token Id - The ID of this resource.
- expires String
- expiring Boolean
- Defaults to
true. - name String
- retrieve
Key Boolean - Defaults to
false.
- connector string
- device
Access stringGroup - endpoints
Connector stringAgent Enrollment Token Id - The ID of this resource.
- expires string
- expiring boolean
- Defaults to
true. - name string
- retrieve
Key boolean - Defaults to
false.
- connector str
- device_
access_ strgroup - endpoints_
connector_ stragent_ enrollment_ token_ id - The ID of this resource.
- expires str
- expiring bool
- Defaults to
true. - name str
- retrieve_
key bool - Defaults to
false.
- connector String
- device
Access StringGroup - endpoints
Connector StringAgent Enrollment Token Id - The ID of this resource.
- expires String
- expiring Boolean
- Defaults to
true. - name String
- retrieve
Key Boolean - Defaults to
false.
Outputs
All input properties are implicitly available as output properties. Additionally, the EndpointsConnectorAgentEnrollmentToken resource produces the following output properties:
- expires_
in float - Generated.
- id str
- The provider-assigned unique ID for this managed resource.
- key str
- Generated.
Look up Existing EndpointsConnectorAgentEnrollmentToken Resource
Get an existing EndpointsConnectorAgentEnrollmentToken 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?: EndpointsConnectorAgentEnrollmentTokenState, opts?: CustomResourceOptions): EndpointsConnectorAgentEnrollmentToken@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
connector: Optional[str] = None,
device_access_group: Optional[str] = None,
endpoints_connector_agent_enrollment_token_id: Optional[str] = None,
expires: Optional[str] = None,
expires_in: Optional[float] = None,
expiring: Optional[bool] = None,
key: Optional[str] = None,
name: Optional[str] = None,
retrieve_key: Optional[bool] = None) -> EndpointsConnectorAgentEnrollmentTokenfunc GetEndpointsConnectorAgentEnrollmentToken(ctx *Context, name string, id IDInput, state *EndpointsConnectorAgentEnrollmentTokenState, opts ...ResourceOption) (*EndpointsConnectorAgentEnrollmentToken, error)public static EndpointsConnectorAgentEnrollmentToken Get(string name, Input<string> id, EndpointsConnectorAgentEnrollmentTokenState? state, CustomResourceOptions? opts = null)public static EndpointsConnectorAgentEnrollmentToken get(String name, Output<String> id, EndpointsConnectorAgentEnrollmentTokenState state, CustomResourceOptions options)resources: _: type: authentik:EndpointsConnectorAgentEnrollmentToken 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.
- Connector string
- Device
Access stringGroup - Endpoints
Connector stringAgent Enrollment Token Id - The ID of this resource.
- Expires string
- Expires
In double - Generated.
- Expiring bool
- Defaults to
true. - Key string
- Generated.
- Name string
- Retrieve
Key bool - Defaults to
false.
- Connector string
- Device
Access stringGroup - Endpoints
Connector stringAgent Enrollment Token Id - The ID of this resource.
- Expires string
- Expires
In float64 - Generated.
- Expiring bool
- Defaults to
true. - Key string
- Generated.
- Name string
- Retrieve
Key bool - Defaults to
false.
- connector String
- device
Access StringGroup - endpoints
Connector StringAgent Enrollment Token Id - The ID of this resource.
- expires String
- expires
In Double - Generated.
- expiring Boolean
- Defaults to
true. - key String
- Generated.
- name String
- retrieve
Key Boolean - Defaults to
false.
- connector string
- device
Access stringGroup - endpoints
Connector stringAgent Enrollment Token Id - The ID of this resource.
- expires string
- expires
In number - Generated.
- expiring boolean
- Defaults to
true. - key string
- Generated.
- name string
- retrieve
Key boolean - Defaults to
false.
- connector str
- device_
access_ strgroup - endpoints_
connector_ stragent_ enrollment_ token_ id - The ID of this resource.
- expires str
- expires_
in float - Generated.
- expiring bool
- Defaults to
true. - key str
- Generated.
- name str
- retrieve_
key bool - Defaults to
false.
- connector String
- device
Access StringGroup - endpoints
Connector StringAgent Enrollment Token Id - The ID of this resource.
- expires String
- expires
In Number - Generated.
- expiring Boolean
- Defaults to
true. - key String
- Generated.
- name String
- retrieve
Key Boolean - Defaults to
false.
Package Details
- Repository
- authentik goauthentik/terraform-provider-authentik
- License
- Notes
- This Pulumi package is based on the
authentikTerraform Provider.
