fusionauth.FusionAuthGenericConnector
Explore with Pulumi AI
# Generic Connector Resource
A FusionAuth Generic Connector is a named object that provides configuration for allowing authentication against external systems.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";
const example = new fusionauth.FusionAuthGenericConnector("example", {
authenticationUrl: "http://mygameserver.local:7001/fusionauth-connector",
connectTimeout: 1000,
data: {
foo: "bar",
},
debug: false,
headers: {
foo: "bar",
bar: "baz",
},
httpAuthenticationPassword: "supersecret",
httpAuthenticationUsername: "me",
readTimeout: 2000,
sslCertificateKeyId: "00000000-0000-0000-0000-000000000678",
});
import pulumi
import theogravity_pulumi-fusionauth as fusionauth
example = fusionauth.FusionAuthGenericConnector("example",
authentication_url="http://mygameserver.local:7001/fusionauth-connector",
connect_timeout=1000,
data={
"foo": "bar",
},
debug=False,
headers={
"foo": "bar",
"bar": "baz",
},
http_authentication_password="supersecret",
http_authentication_username="me",
read_timeout=2000,
ssl_certificate_key_id="00000000-0000-0000-0000-000000000678")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := fusionauth.NewFusionAuthGenericConnector(ctx, "example", &fusionauth.FusionAuthGenericConnectorArgs{
AuthenticationUrl: pulumi.String("http://mygameserver.local:7001/fusionauth-connector"),
ConnectTimeout: pulumi.Int(1000),
Data: pulumi.Map{
"foo": pulumi.Any("bar"),
},
Debug: pulumi.Bool(false),
Headers: pulumi.Map{
"foo": pulumi.Any("bar"),
"bar": pulumi.Any("baz"),
},
HttpAuthenticationPassword: pulumi.String("supersecret"),
HttpAuthenticationUsername: pulumi.String("me"),
ReadTimeout: pulumi.Int(2000),
SslCertificateKeyId: pulumi.String("00000000-0000-0000-0000-000000000678"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;
return await Deployment.RunAsync(() =>
{
var example = new Fusionauth.FusionAuthGenericConnector("example", new()
{
AuthenticationUrl = "http://mygameserver.local:7001/fusionauth-connector",
ConnectTimeout = 1000,
Data =
{
{ "foo", "bar" },
},
Debug = false,
Headers =
{
{ "foo", "bar" },
{ "bar", "baz" },
},
HttpAuthenticationPassword = "supersecret",
HttpAuthenticationUsername = "me",
ReadTimeout = 2000,
SslCertificateKeyId = "00000000-0000-0000-0000-000000000678",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthGenericConnector;
import com.pulumi.fusionauth.FusionAuthGenericConnectorArgs;
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 example = new FusionAuthGenericConnector("example", FusionAuthGenericConnectorArgs.builder()
.authenticationUrl("http://mygameserver.local:7001/fusionauth-connector")
.connectTimeout(1000)
.data(Map.of("foo", "bar"))
.debug(false)
.headers(Map.ofEntries(
Map.entry("foo", "bar"),
Map.entry("bar", "baz")
))
.httpAuthenticationPassword("supersecret")
.httpAuthenticationUsername("me")
.readTimeout(2000)
.sslCertificateKeyId("00000000-0000-0000-0000-000000000678")
.build());
}
}
resources:
example:
type: fusionauth:FusionAuthGenericConnector
properties:
authenticationUrl: http://mygameserver.local:7001/fusionauth-connector
connectTimeout: 1000
data:
foo: bar
debug: false
headers:
foo: bar
bar: baz
httpAuthenticationPassword: supersecret
httpAuthenticationUsername: me
readTimeout: 2000
sslCertificateKeyId: 00000000-0000-0000-0000-000000000678
Create FusionAuthGenericConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FusionAuthGenericConnector(name: string, args: FusionAuthGenericConnectorArgs, opts?: CustomResourceOptions);
@overload
def FusionAuthGenericConnector(resource_name: str,
args: FusionAuthGenericConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FusionAuthGenericConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
authentication_url: Optional[str] = None,
connect_timeout: Optional[int] = None,
read_timeout: Optional[int] = None,
data: Optional[Mapping[str, Any]] = None,
debug: Optional[bool] = None,
headers: Optional[Mapping[str, Any]] = None,
http_authentication_password: Optional[str] = None,
http_authentication_username: Optional[str] = None,
name: Optional[str] = None,
ssl_certificate_key_id: Optional[str] = None)
func NewFusionAuthGenericConnector(ctx *Context, name string, args FusionAuthGenericConnectorArgs, opts ...ResourceOption) (*FusionAuthGenericConnector, error)
public FusionAuthGenericConnector(string name, FusionAuthGenericConnectorArgs args, CustomResourceOptions? opts = null)
public FusionAuthGenericConnector(String name, FusionAuthGenericConnectorArgs args)
public FusionAuthGenericConnector(String name, FusionAuthGenericConnectorArgs args, CustomResourceOptions options)
type: fusionauth:FusionAuthGenericConnector
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 FusionAuthGenericConnectorArgs
- 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 FusionAuthGenericConnectorArgs
- 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 FusionAuthGenericConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FusionAuthGenericConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FusionAuthGenericConnectorArgs
- 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 fusionAuthGenericConnectorResource = new Fusionauth.FusionAuthGenericConnector("fusionAuthGenericConnectorResource", new()
{
AuthenticationUrl = "string",
ConnectTimeout = 0,
ReadTimeout = 0,
Data =
{
{ "string", "any" },
},
Debug = false,
Headers =
{
{ "string", "any" },
},
HttpAuthenticationPassword = "string",
HttpAuthenticationUsername = "string",
Name = "string",
SslCertificateKeyId = "string",
});
example, err := fusionauth.NewFusionAuthGenericConnector(ctx, "fusionAuthGenericConnectorResource", &fusionauth.FusionAuthGenericConnectorArgs{
AuthenticationUrl: pulumi.String("string"),
ConnectTimeout: pulumi.Int(0),
ReadTimeout: pulumi.Int(0),
Data: pulumi.Map{
"string": pulumi.Any("any"),
},
Debug: pulumi.Bool(false),
Headers: pulumi.Map{
"string": pulumi.Any("any"),
},
HttpAuthenticationPassword: pulumi.String("string"),
HttpAuthenticationUsername: pulumi.String("string"),
Name: pulumi.String("string"),
SslCertificateKeyId: pulumi.String("string"),
})
var fusionAuthGenericConnectorResource = new FusionAuthGenericConnector("fusionAuthGenericConnectorResource", FusionAuthGenericConnectorArgs.builder()
.authenticationUrl("string")
.connectTimeout(0)
.readTimeout(0)
.data(Map.of("string", "any"))
.debug(false)
.headers(Map.of("string", "any"))
.httpAuthenticationPassword("string")
.httpAuthenticationUsername("string")
.name("string")
.sslCertificateKeyId("string")
.build());
fusion_auth_generic_connector_resource = fusionauth.FusionAuthGenericConnector("fusionAuthGenericConnectorResource",
authentication_url="string",
connect_timeout=0,
read_timeout=0,
data={
"string": "any",
},
debug=False,
headers={
"string": "any",
},
http_authentication_password="string",
http_authentication_username="string",
name="string",
ssl_certificate_key_id="string")
const fusionAuthGenericConnectorResource = new fusionauth.FusionAuthGenericConnector("fusionAuthGenericConnectorResource", {
authenticationUrl: "string",
connectTimeout: 0,
readTimeout: 0,
data: {
string: "any",
},
debug: false,
headers: {
string: "any",
},
httpAuthenticationPassword: "string",
httpAuthenticationUsername: "string",
name: "string",
sslCertificateKeyId: "string",
});
type: fusionauth:FusionAuthGenericConnector
properties:
authenticationUrl: string
connectTimeout: 0
data:
string: any
debug: false
headers:
string: any
httpAuthenticationPassword: string
httpAuthenticationUsername: string
name: string
readTimeout: 0
sslCertificateKeyId: string
FusionAuthGenericConnector 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 FusionAuthGenericConnector resource accepts the following input properties:
- Authentication
Url string - The fully qualified URL used to send an HTTP request to authenticate the user.
- Connect
Timeout int - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- Read
Timeout int - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- Data Dictionary<string, object>
- An object that can hold any information about the Connector that should be persisted.
- Debug bool
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- Headers Dictionary<string, object>
- An object that can hold HTTPHeader key and value pairs.
- Http
Authentication stringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- Http
Authentication stringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- Name string
- The unique Connector name.
- Ssl
Certificate stringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- Authentication
Url string - The fully qualified URL used to send an HTTP request to authenticate the user.
- Connect
Timeout int - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- Read
Timeout int - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- Data map[string]interface{}
- An object that can hold any information about the Connector that should be persisted.
- Debug bool
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- Headers map[string]interface{}
- An object that can hold HTTPHeader key and value pairs.
- Http
Authentication stringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- Http
Authentication stringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- Name string
- The unique Connector name.
- Ssl
Certificate stringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication
Url String - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect
Timeout Integer - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- read
Timeout Integer - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- data Map<String,Object>
- An object that can hold any information about the Connector that should be persisted.
- debug Boolean
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers Map<String,Object>
- An object that can hold HTTPHeader key and value pairs.
- http
Authentication StringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http
Authentication StringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name String
- The unique Connector name.
- ssl
Certificate StringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication
Url string - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect
Timeout number - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- read
Timeout number - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- data {[key: string]: any}
- An object that can hold any information about the Connector that should be persisted.
- debug boolean
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers {[key: string]: any}
- An object that can hold HTTPHeader key and value pairs.
- http
Authentication stringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http
Authentication stringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name string
- The unique Connector name.
- ssl
Certificate stringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication_
url str - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect_
timeout int - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- read_
timeout int - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- data Mapping[str, Any]
- An object that can hold any information about the Connector that should be persisted.
- debug bool
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers Mapping[str, Any]
- An object that can hold HTTPHeader key and value pairs.
- http_
authentication_ strpassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http_
authentication_ strusername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name str
- The unique Connector name.
- ssl_
certificate_ strkey_ id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication
Url String - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect
Timeout Number - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- read
Timeout Number - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- data Map<Any>
- An object that can hold any information about the Connector that should be persisted.
- debug Boolean
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers Map<Any>
- An object that can hold HTTPHeader key and value pairs.
- http
Authentication StringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http
Authentication StringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name String
- The unique Connector name.
- ssl
Certificate StringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
Outputs
All input properties are implicitly available as output properties. Additionally, the FusionAuthGenericConnector 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 FusionAuthGenericConnector Resource
Get an existing FusionAuthGenericConnector 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?: FusionAuthGenericConnectorState, opts?: CustomResourceOptions): FusionAuthGenericConnector
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authentication_url: Optional[str] = None,
connect_timeout: Optional[int] = None,
data: Optional[Mapping[str, Any]] = None,
debug: Optional[bool] = None,
headers: Optional[Mapping[str, Any]] = None,
http_authentication_password: Optional[str] = None,
http_authentication_username: Optional[str] = None,
name: Optional[str] = None,
read_timeout: Optional[int] = None,
ssl_certificate_key_id: Optional[str] = None) -> FusionAuthGenericConnector
func GetFusionAuthGenericConnector(ctx *Context, name string, id IDInput, state *FusionAuthGenericConnectorState, opts ...ResourceOption) (*FusionAuthGenericConnector, error)
public static FusionAuthGenericConnector Get(string name, Input<string> id, FusionAuthGenericConnectorState? state, CustomResourceOptions? opts = null)
public static FusionAuthGenericConnector get(String name, Output<String> id, FusionAuthGenericConnectorState 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.
- Authentication
Url string - The fully qualified URL used to send an HTTP request to authenticate the user.
- Connect
Timeout int - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- Data Dictionary<string, object>
- An object that can hold any information about the Connector that should be persisted.
- Debug bool
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- Headers Dictionary<string, object>
- An object that can hold HTTPHeader key and value pairs.
- Http
Authentication stringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- Http
Authentication stringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- Name string
- The unique Connector name.
- Read
Timeout int - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- Ssl
Certificate stringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- Authentication
Url string - The fully qualified URL used to send an HTTP request to authenticate the user.
- Connect
Timeout int - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- Data map[string]interface{}
- An object that can hold any information about the Connector that should be persisted.
- Debug bool
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- Headers map[string]interface{}
- An object that can hold HTTPHeader key and value pairs.
- Http
Authentication stringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- Http
Authentication stringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- Name string
- The unique Connector name.
- Read
Timeout int - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- Ssl
Certificate stringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication
Url String - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect
Timeout Integer - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- data Map<String,Object>
- An object that can hold any information about the Connector that should be persisted.
- debug Boolean
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers Map<String,Object>
- An object that can hold HTTPHeader key and value pairs.
- http
Authentication StringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http
Authentication StringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name String
- The unique Connector name.
- read
Timeout Integer - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- ssl
Certificate StringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication
Url string - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect
Timeout number - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- data {[key: string]: any}
- An object that can hold any information about the Connector that should be persisted.
- debug boolean
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers {[key: string]: any}
- An object that can hold HTTPHeader key and value pairs.
- http
Authentication stringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http
Authentication stringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name string
- The unique Connector name.
- read
Timeout number - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- ssl
Certificate stringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication_
url str - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect_
timeout int - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- data Mapping[str, Any]
- An object that can hold any information about the Connector that should be persisted.
- debug bool
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers Mapping[str, Any]
- An object that can hold HTTPHeader key and value pairs.
- http_
authentication_ strpassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http_
authentication_ strusername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name str
- The unique Connector name.
- read_
timeout int - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- ssl_
certificate_ strkey_ id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
- authentication
Url String - The fully qualified URL used to send an HTTP request to authenticate the user.
- connect
Timeout Number - The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
- data Map<Any>
- An object that can hold any information about the Connector that should be persisted.
- debug Boolean
- Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
- headers Map<Any>
- An object that can hold HTTPHeader key and value pairs.
- http
Authentication StringPassword - The HTTP basic authentication password that is sent as part of the HTTP request for the events.
- http
Authentication StringUsername - The HTTP basic authentication username that is sent as part of the HTTP request for the events.
- name String
- The unique Connector name.
- read
Timeout Number - The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
- ssl
Certificate StringKey Id - The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.
Package Details
- Repository
- fusionauth theogravity/pulumi-fusionauth
- License
- MIT
- Notes
- This Pulumi package is based on the
fusionauth
Terraform Provider.