Manages a GitLab connector in Dex. This connector allows users to authenticate using their GitLab accounts and supports group-based access control.
Create GitLabConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GitLabConnector(name: string, args: GitLabConnectorArgs, opts?: CustomResourceOptions);@overload
def GitLabConnector(resource_name: str,
args: GitLabConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GitLabConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
connector_id: Optional[str] = None,
name: Optional[str] = None,
redirect_uri: Optional[str] = None,
base_url: Optional[str] = None,
get_groups_permission: Optional[bool] = None,
groups: Optional[Sequence[str]] = None,
use_login_as_id: Optional[bool] = None)func NewGitLabConnector(ctx *Context, name string, args GitLabConnectorArgs, opts ...ResourceOption) (*GitLabConnector, error)public GitLabConnector(string name, GitLabConnectorArgs args, CustomResourceOptions? opts = null)
public GitLabConnector(String name, GitLabConnectorArgs args)
public GitLabConnector(String name, GitLabConnectorArgs args, CustomResourceOptions options)
type: dex:resources:GitLabConnector
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 GitLabConnectorArgs
- 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 GitLabConnectorArgs
- 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 GitLabConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GitLabConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GitLabConnectorArgs
- 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 gitLabConnectorResource = new Dex.Resources.GitLabConnector("gitLabConnectorResource", new()
{
ClientId = "string",
ClientSecret = "string",
ConnectorId = "string",
Name = "string",
RedirectUri = "string",
BaseURL = "string",
GetGroupsPermission = false,
Groups = new[]
{
"string",
},
UseLoginAsID = false,
});
example, err := resources.NewGitLabConnector(ctx, "gitLabConnectorResource", &resources.GitLabConnectorArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ConnectorId: pulumi.String("string"),
Name: pulumi.String("string"),
RedirectUri: pulumi.String("string"),
BaseURL: pulumi.String("string"),
GetGroupsPermission: pulumi.Bool(false),
Groups: pulumi.StringArray{
pulumi.String("string"),
},
UseLoginAsID: pulumi.Bool(false),
})
var gitLabConnectorResource = new GitLabConnector("gitLabConnectorResource", GitLabConnectorArgs.builder()
.clientId("string")
.clientSecret("string")
.connectorId("string")
.name("string")
.redirectUri("string")
.baseURL("string")
.getGroupsPermission(false)
.groups("string")
.useLoginAsID(false)
.build());
git_lab_connector_resource = dex.resources.GitLabConnector("gitLabConnectorResource",
client_id="string",
client_secret="string",
connector_id="string",
name="string",
redirect_uri="string",
base_url="string",
get_groups_permission=False,
groups=["string"],
use_login_as_id=False)
const gitLabConnectorResource = new dex.resources.GitLabConnector("gitLabConnectorResource", {
clientId: "string",
clientSecret: "string",
connectorId: "string",
name: "string",
redirectUri: "string",
baseURL: "string",
getGroupsPermission: false,
groups: ["string"],
useLoginAsID: false,
});
type: dex:resources:GitLabConnector
properties:
baseURL: string
clientId: string
clientSecret: string
connectorId: string
getGroupsPermission: false
groups:
- string
name: string
redirectUri: string
useLoginAsID: false
GitLabConnector 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 GitLabConnector resource accepts the following input properties:
- Client
Id string - GitLab OAuth application client ID.
- Client
Secret string - GitLab OAuth application client secret.
- Connector
Id string - Unique identifier for the GitLab connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in GitLab OAuth app. Must match Dex's callback URL.
- Base
URL string - GitLab instance base URL. Defaults to 'https://gitlab.com' for GitLab.com.
- Get
Groups boolPermission - If true, request 'read_api' scope to fetch group memberships. Defaults to false.
- Groups List<string>
- List of GitLab group names. Only users in these groups will be allowed to authenticate.
- Use
Login boolAs ID - If true, use GitLab username as the user ID. Defaults to false.
- Client
Id string - GitLab OAuth application client ID.
- Client
Secret string - GitLab OAuth application client secret.
- Connector
Id string - Unique identifier for the GitLab connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in GitLab OAuth app. Must match Dex's callback URL.
- Base
URL string - GitLab instance base URL. Defaults to 'https://gitlab.com' for GitLab.com.
- Get
Groups boolPermission - If true, request 'read_api' scope to fetch group memberships. Defaults to false.
- Groups []string
- List of GitLab group names. Only users in these groups will be allowed to authenticate.
- Use
Login boolAs ID - If true, use GitLab username as the user ID. Defaults to false.
- client
Id String - GitLab OAuth application client ID.
- client
Secret String - GitLab OAuth application client secret.
- connector
Id String - Unique identifier for the GitLab connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in GitLab OAuth app. Must match Dex's callback URL.
- base
URL String - GitLab instance base URL. Defaults to 'https://gitlab.com' for GitLab.com.
- get
Groups BooleanPermission - If true, request 'read_api' scope to fetch group memberships. Defaults to false.
- groups List<String>
- List of GitLab group names. Only users in these groups will be allowed to authenticate.
- use
Login BooleanAs ID - If true, use GitLab username as the user ID. Defaults to false.
- client
Id string - GitLab OAuth application client ID.
- client
Secret string - GitLab OAuth application client secret.
- connector
Id string - Unique identifier for the GitLab connector.
- name string
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri string - Redirect URI registered in GitLab OAuth app. Must match Dex's callback URL.
- base
URL string - GitLab instance base URL. Defaults to 'https://gitlab.com' for GitLab.com.
- get
Groups booleanPermission - If true, request 'read_api' scope to fetch group memberships. Defaults to false.
- groups string[]
- List of GitLab group names. Only users in these groups will be allowed to authenticate.
- use
Login booleanAs ID - If true, use GitLab username as the user ID. Defaults to false.
- client_
id str - GitLab OAuth application client ID.
- client_
secret str - GitLab OAuth application client secret.
- connector_
id str - Unique identifier for the GitLab connector.
- name str
- Human-readable name for the connector, displayed to users during login.
- redirect_
uri str - Redirect URI registered in GitLab OAuth app. Must match Dex's callback URL.
- base_
url str - GitLab instance base URL. Defaults to 'https://gitlab.com' for GitLab.com.
- get_
groups_ boolpermission - If true, request 'read_api' scope to fetch group memberships. Defaults to false.
- groups Sequence[str]
- List of GitLab group names. Only users in these groups will be allowed to authenticate.
- use_
login_ boolas_ id - If true, use GitLab username as the user ID. Defaults to false.
- client
Id String - GitLab OAuth application client ID.
- client
Secret String - GitLab OAuth application client secret.
- connector
Id String - Unique identifier for the GitLab connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in GitLab OAuth app. Must match Dex's callback URL.
- base
URL String - GitLab instance base URL. Defaults to 'https://gitlab.com' for GitLab.com.
- get
Groups BooleanPermission - If true, request 'read_api' scope to fetch group memberships. Defaults to false.
- groups List<String>
- List of GitLab group names. Only users in these groups will be allowed to authenticate.
- use
Login BooleanAs ID - If true, use GitLab username as the user ID. Defaults to false.
Outputs
All input properties are implicitly available as output properties. Additionally, the GitLabConnector 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.
Package Details
- Repository
- dex kotaicode/pulumi-dex
- License
