Class AccessIdentityProvider
Provides a Cloudflare Access Identity Provider resource. Identity Providers are used as an authentication or authorisation source within Access.
Example Usage
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
class MyStack : Stack
{
public MyStack()
{
// one time pin
var pinLogin = new Cloudflare.AccessIdentityProvider("pinLogin", new Cloudflare.AccessIdentityProviderArgs
{
AccountId = "1d5fdc9e88c8a8c4518b068cd94331fe",
Name = "PIN login",
Type = "onetimepin",
});
// oauth
var githubOauth = new Cloudflare.AccessIdentityProvider("githubOauth", new Cloudflare.AccessIdentityProviderArgs
{
AccountId = "1d5fdc9e88c8a8c4518b068cd94331fe",
Configs =
{
new Cloudflare.Inputs.AccessIdentityProviderConfigArgs
{
ClientId = "example",
ClientSecret = "secret_key",
},
},
Name = "GitHub OAuth",
Type = "github",
});
// saml
var jumpcloudSaml = new Cloudflare.AccessIdentityProvider("jumpcloudSaml", new Cloudflare.AccessIdentityProviderArgs
{
AccountId = "1d5fdc9e88c8a8c4518b068cd94331fe",
Configs =
{
new Cloudflare.Inputs.AccessIdentityProviderConfigArgs
{
Attributes =
{
"email",
"username",
},
IdpPublicCert = @"MIIDpDCCAoygAwIBAgIGAV2ka+55MA0GCSqGSIb3DQEBCwUAMIGSMQswCQ...GF/Q2/MHadws97cZg
uTnQyuOqPuHbnN83d/2l1NSYKCbHt24o
",
IssuerUrl = "jumpcloud",
SignRequest = false,
SsoTargetUrl = "https://sso.myexample.jumpcloud.com/saml2/cloudflareaccess",
},
},
Name = "JumpCloud SAML",
Type = "saml",
});
}
}
Inherited Members
Namespace: Pulumi.Cloudflare
Assembly: Pulumi.Cloudflare.dll
Syntax
public class AccessIdentityProvider : CustomResource
Constructors
View SourceAccessIdentityProvider(String, AccessIdentityProviderArgs, CustomResourceOptions)
Create a AccessIdentityProvider resource with the given unique name, arguments, and options.
Declaration
public AccessIdentityProvider(string name, AccessIdentityProviderArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| AccessIdentityProviderArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAccountId
Declaration
public Output<string> AccountId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Configs
Provider configuration from the [developer documentation][access_identity_provider_guide].
Declaration
public Output<ImmutableArray<AccessIdentityProviderConfig>> Configs { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<AccessIdentityProviderConfig>> |
Name
Friendly name of the Access Identity Provider configuration.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Type
The provider type to use. Must be one of: "centrify",
"facebook", "google-apps", "oidc", "github", "google", "saml",
"linkedin", "azureAD", "okta", "onetimepin", "onelogin", "yandex".
Declaration
public Output<string> Type { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, AccessIdentityProviderState, CustomResourceOptions)
Get an existing AccessIdentityProvider resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static AccessIdentityProvider Get(string name, Input<string> id, AccessIdentityProviderState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| AccessIdentityProviderState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| AccessIdentityProvider |