Manages an OAuth2 client in Dex. OAuth2 clients are applications that can authenticate users through Dex.
Create Client Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Client(name: string, args: ClientArgs, opts?: CustomResourceOptions);@overload
def Client(resource_name: str,
args: ClientArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Client(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
name: Optional[str] = None,
redirect_uris: Optional[Sequence[str]] = None,
logo_url: Optional[str] = None,
public: Optional[bool] = None,
secret: Optional[str] = None,
trusted_peers: Optional[Sequence[str]] = None)func NewClient(ctx *Context, name string, args ClientArgs, opts ...ResourceOption) (*Client, error)public Client(string name, ClientArgs args, CustomResourceOptions? opts = null)
public Client(String name, ClientArgs args)
public Client(String name, ClientArgs args, CustomResourceOptions options)
type: dex:resources:Client
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 ClientArgs
- 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 ClientArgs
- 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 ClientArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientArgs
- 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 clientResource = new Dex.Resources.Client("clientResource", new()
{
ClientId = "string",
Name = "string",
RedirectUris = new[]
{
"string",
},
LogoUrl = "string",
Public = false,
Secret = "string",
TrustedPeers = new[]
{
"string",
},
});
example, err := resources.NewClient(ctx, "clientResource", &resources.ClientArgs{
ClientId: pulumi.String("string"),
Name: pulumi.String("string"),
RedirectUris: pulumi.StringArray{
pulumi.String("string"),
},
LogoUrl: pulumi.String("string"),
Public: pulumi.Bool(false),
Secret: pulumi.String("string"),
TrustedPeers: pulumi.StringArray{
pulumi.String("string"),
},
})
var clientResource = new Client("clientResource", ClientArgs.builder()
.clientId("string")
.name("string")
.redirectUris("string")
.logoUrl("string")
.public_(false)
.secret("string")
.trustedPeers("string")
.build());
client_resource = dex.resources.Client("clientResource",
client_id="string",
name="string",
redirect_uris=["string"],
logo_url="string",
public=False,
secret="string",
trusted_peers=["string"])
const clientResource = new dex.resources.Client("clientResource", {
clientId: "string",
name: "string",
redirectUris: ["string"],
logoUrl: "string",
"public": false,
secret: "string",
trustedPeers: ["string"],
});
type: dex:resources:Client
properties:
clientId: string
logoUrl: string
name: string
public: false
redirectUris:
- string
secret: string
trustedPeers:
- string
Client 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 Client resource accepts the following input properties:
- Client
Id string - Unique identifier for the OAuth2 client. This is used as the client_id in OAuth2 flows.
- Name string
- Human-readable name for the OAuth2 client.
- Redirect
Uris List<string> - List of allowed redirect URIs for OAuth2 authorization flows. Must be valid HTTP/HTTPS URLs.
- Logo
Url string - URL to a logo image for the OAuth2 client. Used in consent screens.
- Public bool
- If true, this client is a public client (e.g., mobile app) and does not require a client secret.
- Secret string
- Client secret for the OAuth2 client. If not provided, a secure random secret will be generated automatically.
- Trusted
Peers List<string> - List of trusted peer client IDs that can exchange tokens with this client.
- Client
Id string - Unique identifier for the OAuth2 client. This is used as the client_id in OAuth2 flows.
- Name string
- Human-readable name for the OAuth2 client.
- Redirect
Uris []string - List of allowed redirect URIs for OAuth2 authorization flows. Must be valid HTTP/HTTPS URLs.
- Logo
Url string - URL to a logo image for the OAuth2 client. Used in consent screens.
- Public bool
- If true, this client is a public client (e.g., mobile app) and does not require a client secret.
- Secret string
- Client secret for the OAuth2 client. If not provided, a secure random secret will be generated automatically.
- Trusted
Peers []string - List of trusted peer client IDs that can exchange tokens with this client.
- client
Id String - Unique identifier for the OAuth2 client. This is used as the client_id in OAuth2 flows.
- name String
- Human-readable name for the OAuth2 client.
- redirect
Uris List<String> - List of allowed redirect URIs for OAuth2 authorization flows. Must be valid HTTP/HTTPS URLs.
- logo
Url String - URL to a logo image for the OAuth2 client. Used in consent screens.
- public_ Boolean
- If true, this client is a public client (e.g., mobile app) and does not require a client secret.
- secret String
- Client secret for the OAuth2 client. If not provided, a secure random secret will be generated automatically.
- trusted
Peers List<String> - List of trusted peer client IDs that can exchange tokens with this client.
- client
Id string - Unique identifier for the OAuth2 client. This is used as the client_id in OAuth2 flows.
- name string
- Human-readable name for the OAuth2 client.
- redirect
Uris string[] - List of allowed redirect URIs for OAuth2 authorization flows. Must be valid HTTP/HTTPS URLs.
- logo
Url string - URL to a logo image for the OAuth2 client. Used in consent screens.
- public boolean
- If true, this client is a public client (e.g., mobile app) and does not require a client secret.
- secret string
- Client secret for the OAuth2 client. If not provided, a secure random secret will be generated automatically.
- trusted
Peers string[] - List of trusted peer client IDs that can exchange tokens with this client.
- client_
id str - Unique identifier for the OAuth2 client. This is used as the client_id in OAuth2 flows.
- name str
- Human-readable name for the OAuth2 client.
- redirect_
uris Sequence[str] - List of allowed redirect URIs for OAuth2 authorization flows. Must be valid HTTP/HTTPS URLs.
- logo_
url str - URL to a logo image for the OAuth2 client. Used in consent screens.
- public bool
- If true, this client is a public client (e.g., mobile app) and does not require a client secret.
- secret str
- Client secret for the OAuth2 client. If not provided, a secure random secret will be generated automatically.
- trusted_
peers Sequence[str] - List of trusted peer client IDs that can exchange tokens with this client.
- client
Id String - Unique identifier for the OAuth2 client. This is used as the client_id in OAuth2 flows.
- name String
- Human-readable name for the OAuth2 client.
- redirect
Uris List<String> - List of allowed redirect URIs for OAuth2 authorization flows. Must be valid HTTP/HTTPS URLs.
- logo
Url String - URL to a logo image for the OAuth2 client. Used in consent screens.
- public Boolean
- If true, this client is a public client (e.g., mobile app) and does not require a client secret.
- secret String
- Client secret for the OAuth2 client. If not provided, a secure random secret will be generated automatically.
- trusted
Peers List<String> - List of trusted peer client IDs that can exchange tokens with this client.
Outputs
All input properties are implicitly available as output properties. Additionally, the Client resource produces the following output properties:
- id str
- The provider-assigned unique ID for this managed resource.
- created_
at str - Timestamp when the client was created (RFC3339 format).
Package Details
- Repository
- dex kotaicode/pulumi-dex
- License
