authentik.EndpointsConnectorAgent

authentik 2025.12.0, Jan 14 26

authentik 2025.12.0 published on Wednesday, Jan 14, 2026 by goauthentik

Schema (JSON)

goauthentik/terraform-provider-authentik

authentik 2025.12.0 published on Wednesday, Jan 14, 2026 by goauthentik

Schema (JSON)

goauthentik/terraform-provider-authentik

Create EndpointsConnectorAgent Resource

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

Constructor syntax

new EndpointsConnectorAgent(name: string, args?: EndpointsConnectorAgentArgs, opts?: CustomResourceOptions);

@overload
def EndpointsConnectorAgent(resource_name: str,
                            args: Optional[EndpointsConnectorAgentArgs] = None,
                            opts: Optional[ResourceOptions] = None)

@overload
def EndpointsConnectorAgent(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            auth_session_duration: Optional[str] = None,
                            auth_terminate_session_on_expiry: Optional[bool] = None,
                            authorization_flow: Optional[str] = None,
                            challenge_idle_timeout: Optional[str] = None,
                            challenge_key: Optional[str] = None,
                            challenge_trigger_check_in: Optional[bool] = None,
                            enabled: Optional[bool] = None,
                            endpoints_connector_agent_id: Optional[str] = None,
                            jwt_federation_providers: Optional[Sequence[str]] = None,
                            name: Optional[str] = None,
                            nss_gid_offset: Optional[float] = None,
                            nss_uid_offset: Optional[float] = None,
                            refresh_interval: Optional[str] = None,
                            snapshot_expiry: Optional[str] = None)

func NewEndpointsConnectorAgent(ctx *Context, name string, args *EndpointsConnectorAgentArgs, opts ...ResourceOption) (*EndpointsConnectorAgent, error)

public EndpointsConnectorAgent(string name, EndpointsConnectorAgentArgs? args = null, CustomResourceOptions? opts = null)

public EndpointsConnectorAgent(String name, EndpointsConnectorAgentArgs args)
public EndpointsConnectorAgent(String name, EndpointsConnectorAgentArgs args, CustomResourceOptions options)

type: authentik:EndpointsConnectorAgent
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 EndpointsConnectorAgentArgs: 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 EndpointsConnectorAgentArgs: 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 EndpointsConnectorAgentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointsConnectorAgentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointsConnectorAgentArgs: 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 endpointsConnectorAgentResource = new Authentik.EndpointsConnectorAgent("endpointsConnectorAgentResource", new()
{
    AuthSessionDuration = "string",
    AuthTerminateSessionOnExpiry = false,
    AuthorizationFlow = "string",
    ChallengeIdleTimeout = "string",
    ChallengeKey = "string",
    ChallengeTriggerCheckIn = false,
    Enabled = false,
    EndpointsConnectorAgentId = "string",
    JwtFederationProviders = new[]
    {
        "string",
    },
    Name = "string",
    NssGidOffset = 0,
    NssUidOffset = 0,
    RefreshInterval = "string",
    SnapshotExpiry = "string",
});

example, err := authentik.NewEndpointsConnectorAgent(ctx, "endpointsConnectorAgentResource", &authentik.EndpointsConnectorAgentArgs{
	AuthSessionDuration:          pulumi.String("string"),
	AuthTerminateSessionOnExpiry: pulumi.Bool(false),
	AuthorizationFlow:            pulumi.String("string"),
	ChallengeIdleTimeout:         pulumi.String("string"),
	ChallengeKey:                 pulumi.String("string"),
	ChallengeTriggerCheckIn:      pulumi.Bool(false),
	Enabled:                      pulumi.Bool(false),
	EndpointsConnectorAgentId:    pulumi.String("string"),
	JwtFederationProviders: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:            pulumi.String("string"),
	NssGidOffset:    pulumi.Float64(0),
	NssUidOffset:    pulumi.Float64(0),
	RefreshInterval: pulumi.String("string"),
	SnapshotExpiry:  pulumi.String("string"),
})

var endpointsConnectorAgentResource = new EndpointsConnectorAgent("endpointsConnectorAgentResource", EndpointsConnectorAgentArgs.builder()
    .authSessionDuration("string")
    .authTerminateSessionOnExpiry(false)
    .authorizationFlow("string")
    .challengeIdleTimeout("string")
    .challengeKey("string")
    .challengeTriggerCheckIn(false)
    .enabled(false)
    .endpointsConnectorAgentId("string")
    .jwtFederationProviders("string")
    .name("string")
    .nssGidOffset(0.0)
    .nssUidOffset(0.0)
    .refreshInterval("string")
    .snapshotExpiry("string")
    .build());

endpoints_connector_agent_resource = authentik.EndpointsConnectorAgent("endpointsConnectorAgentResource",
    auth_session_duration="string",
    auth_terminate_session_on_expiry=False,
    authorization_flow="string",
    challenge_idle_timeout="string",
    challenge_key="string",
    challenge_trigger_check_in=False,
    enabled=False,
    endpoints_connector_agent_id="string",
    jwt_federation_providers=["string"],
    name="string",
    nss_gid_offset=0,
    nss_uid_offset=0,
    refresh_interval="string",
    snapshot_expiry="string")

const endpointsConnectorAgentResource = new authentik.EndpointsConnectorAgent("endpointsConnectorAgentResource", {
    authSessionDuration: "string",
    authTerminateSessionOnExpiry: false,
    authorizationFlow: "string",
    challengeIdleTimeout: "string",
    challengeKey: "string",
    challengeTriggerCheckIn: false,
    enabled: false,
    endpointsConnectorAgentId: "string",
    jwtFederationProviders: ["string"],
    name: "string",
    nssGidOffset: 0,
    nssUidOffset: 0,
    refreshInterval: "string",
    snapshotExpiry: "string",
});

type: authentik:EndpointsConnectorAgent
properties:
    authSessionDuration: string
    authTerminateSessionOnExpiry: false
    authorizationFlow: string
    challengeIdleTimeout: string
    challengeKey: string
    challengeTriggerCheckIn: false
    enabled: false
    endpointsConnectorAgentId: string
    jwtFederationProviders:
        - string
    name: string
    nssGidOffset: 0
    nssUidOffset: 0
    refreshInterval: string
    snapshotExpiry: string

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

AuthSessionDuration string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
AuthTerminateSessionOnExpiry bool: Defaults to true.
AuthorizationFlow string
ChallengeIdleTimeout string: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
ChallengeKey string
ChallengeTriggerCheckIn bool: Defaults to true.
Enabled bool: Defaults to true.
EndpointsConnectorAgentId string: The ID of this resource.
JwtFederationProviders List<string>
Name string
NssGidOffset double: Defaults to 4000.
NssUidOffset double: Defaults to 2000.
RefreshInterval string: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
SnapshotExpiry string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

AuthSessionDuration string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
AuthTerminateSessionOnExpiry bool: Defaults to true.
AuthorizationFlow string
ChallengeIdleTimeout string: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
ChallengeKey string
ChallengeTriggerCheckIn bool: Defaults to true.
Enabled bool: Defaults to true.
EndpointsConnectorAgentId string: The ID of this resource.
JwtFederationProviders []string
Name string
NssGidOffset float64: Defaults to 4000.
NssUidOffset float64: Defaults to 2000.
RefreshInterval string: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
SnapshotExpiry string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

authSessionDuration String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
authTerminateSessionOnExpiry Boolean: Defaults to true.
authorizationFlow String
challengeIdleTimeout String: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challengeKey String
challengeTriggerCheckIn Boolean: Defaults to true.
enabled Boolean: Defaults to true.
endpointsConnectorAgentId String: The ID of this resource.
jwtFederationProviders List<String>
name String
nssGidOffset Double: Defaults to 4000.
nssUidOffset Double: Defaults to 2000.
refreshInterval String: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshotExpiry String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

authSessionDuration string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
authTerminateSessionOnExpiry boolean: Defaults to true.
authorizationFlow string
challengeIdleTimeout string: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challengeKey string
challengeTriggerCheckIn boolean: Defaults to true.
enabled boolean: Defaults to true.
endpointsConnectorAgentId string: The ID of this resource.
jwtFederationProviders string[]
name string
nssGidOffset number: Defaults to 4000.
nssUidOffset number: Defaults to 2000.
refreshInterval string: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshotExpiry string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

auth_session_duration str: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
auth_terminate_session_on_expiry bool: Defaults to true.
authorization_flow str
challenge_idle_timeout str: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challenge_key str
challenge_trigger_check_in bool: Defaults to true.
enabled bool: Defaults to true.
endpoints_connector_agent_id str: The ID of this resource.
jwt_federation_providers Sequence[str]
name str
nss_gid_offset float: Defaults to 4000.
nss_uid_offset float: Defaults to 2000.
refresh_interval str: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshot_expiry str: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

authSessionDuration String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
authTerminateSessionOnExpiry Boolean: Defaults to true.
authorizationFlow String
challengeIdleTimeout String: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challengeKey String
challengeTriggerCheckIn Boolean: Defaults to true.
enabled Boolean: Defaults to true.
endpointsConnectorAgentId String: The ID of this resource.
jwtFederationProviders List<String>
name String
nssGidOffset Number: Defaults to 4000.
nssUidOffset Number: Defaults to 2000.
refreshInterval String: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshotExpiry String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

Outputs

All input properties are implicitly available as output properties. Additionally, the EndpointsConnectorAgent 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 EndpointsConnectorAgent Resource

Get an existing EndpointsConnectorAgent 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?: EndpointsConnectorAgentState, opts?: CustomResourceOptions): EndpointsConnectorAgent

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_session_duration: Optional[str] = None,
        auth_terminate_session_on_expiry: Optional[bool] = None,
        authorization_flow: Optional[str] = None,
        challenge_idle_timeout: Optional[str] = None,
        challenge_key: Optional[str] = None,
        challenge_trigger_check_in: Optional[bool] = None,
        enabled: Optional[bool] = None,
        endpoints_connector_agent_id: Optional[str] = None,
        jwt_federation_providers: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        nss_gid_offset: Optional[float] = None,
        nss_uid_offset: Optional[float] = None,
        refresh_interval: Optional[str] = None,
        snapshot_expiry: Optional[str] = None) -> EndpointsConnectorAgent

func GetEndpointsConnectorAgent(ctx *Context, name string, id IDInput, state *EndpointsConnectorAgentState, opts ...ResourceOption) (*EndpointsConnectorAgent, error)

public static EndpointsConnectorAgent Get(string name, Input<string> id, EndpointsConnectorAgentState? state, CustomResourceOptions? opts = null)

public static EndpointsConnectorAgent get(String name, Output<String> id, EndpointsConnectorAgentState state, CustomResourceOptions options)

resources:  _:    type: authentik:EndpointsConnectorAgent    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.

The following state arguments are supported:

AuthSessionDuration string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
AuthTerminateSessionOnExpiry bool: Defaults to true.
AuthorizationFlow string
ChallengeIdleTimeout string: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
ChallengeKey string
ChallengeTriggerCheckIn bool: Defaults to true.
Enabled bool: Defaults to true.
EndpointsConnectorAgentId string: The ID of this resource.
JwtFederationProviders List<string>
Name string
NssGidOffset double: Defaults to 4000.
NssUidOffset double: Defaults to 2000.
RefreshInterval string: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
SnapshotExpiry string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

AuthSessionDuration string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
AuthTerminateSessionOnExpiry bool: Defaults to true.
AuthorizationFlow string
ChallengeIdleTimeout string: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
ChallengeKey string
ChallengeTriggerCheckIn bool: Defaults to true.
Enabled bool: Defaults to true.
EndpointsConnectorAgentId string: The ID of this resource.
JwtFederationProviders []string
Name string
NssGidOffset float64: Defaults to 4000.
NssUidOffset float64: Defaults to 2000.
RefreshInterval string: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
SnapshotExpiry string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

authSessionDuration String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
authTerminateSessionOnExpiry Boolean: Defaults to true.
authorizationFlow String
challengeIdleTimeout String: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challengeKey String
challengeTriggerCheckIn Boolean: Defaults to true.
enabled Boolean: Defaults to true.
endpointsConnectorAgentId String: The ID of this resource.
jwtFederationProviders List<String>
name String
nssGidOffset Double: Defaults to 4000.
nssUidOffset Double: Defaults to 2000.
refreshInterval String: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshotExpiry String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

authSessionDuration string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
authTerminateSessionOnExpiry boolean: Defaults to true.
authorizationFlow string
challengeIdleTimeout string: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challengeKey string
challengeTriggerCheckIn boolean: Defaults to true.
enabled boolean: Defaults to true.
endpointsConnectorAgentId string: The ID of this resource.
jwtFederationProviders string[]
name string
nssGidOffset number: Defaults to 4000.
nssUidOffset number: Defaults to 2000.
refreshInterval string: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshotExpiry string: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

auth_session_duration str: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
auth_terminate_session_on_expiry bool: Defaults to true.
authorization_flow str
challenge_idle_timeout str: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challenge_key str
challenge_trigger_check_in bool: Defaults to true.
enabled bool: Defaults to true.
endpoints_connector_agent_id str: The ID of this resource.
jwt_federation_providers Sequence[str]
name str
nss_gid_offset float: Defaults to 4000.
nss_uid_offset float: Defaults to 2000.
refresh_interval str: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshot_expiry str: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.

authSessionDuration String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=8.
authTerminateSessionOnExpiry Boolean: Defaults to true.
authorizationFlow String
challengeIdleTimeout String: Format: hours=1;minutes=2;seconds=3. Defaults to seconds=3.
challengeKey String
challengeTriggerCheckIn Boolean: Defaults to true.
enabled Boolean: Defaults to true.
endpointsConnectorAgentId String: The ID of this resource.
jwtFederationProviders List<String>
name String
nssGidOffset Number: Defaults to 4000.
nssUidOffset Number: Defaults to 2000.
refreshInterval String: Format: hours=1;minutes=2;seconds=3. Defaults to minutes=30.
snapshotExpiry String: Format: hours=1;minutes=2;seconds=3. Defaults to hours=24.