1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ZeroTrustRiskScoreIntegration
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi

cloudflare.ZeroTrustRiskScoreIntegration

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi

    The Risk Score Integration resource allows you to transmit changes in User Risk Score to a specified vendor such as Okta.

    Create ZeroTrustRiskScoreIntegration Resource

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

    Constructor syntax

    new ZeroTrustRiskScoreIntegration(name: string, args: ZeroTrustRiskScoreIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def ZeroTrustRiskScoreIntegration(resource_name: str,
                                      args: ZeroTrustRiskScoreIntegrationArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ZeroTrustRiskScoreIntegration(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      account_id: Optional[str] = None,
                                      integration_type: Optional[str] = None,
                                      tenant_url: Optional[str] = None,
                                      active: Optional[bool] = None,
                                      reference_id: Optional[str] = None)
    func NewZeroTrustRiskScoreIntegration(ctx *Context, name string, args ZeroTrustRiskScoreIntegrationArgs, opts ...ResourceOption) (*ZeroTrustRiskScoreIntegration, error)
    public ZeroTrustRiskScoreIntegration(string name, ZeroTrustRiskScoreIntegrationArgs args, CustomResourceOptions? opts = null)
    public ZeroTrustRiskScoreIntegration(String name, ZeroTrustRiskScoreIntegrationArgs args)
    public ZeroTrustRiskScoreIntegration(String name, ZeroTrustRiskScoreIntegrationArgs args, CustomResourceOptions options)
    
    type: cloudflare:ZeroTrustRiskScoreIntegration
    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 ZeroTrustRiskScoreIntegrationArgs
    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 ZeroTrustRiskScoreIntegrationArgs
    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 ZeroTrustRiskScoreIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZeroTrustRiskScoreIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZeroTrustRiskScoreIntegrationArgs
    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 zeroTrustRiskScoreIntegrationResource = new Cloudflare.ZeroTrustRiskScoreIntegration("zeroTrustRiskScoreIntegrationResource", new()
    {
        AccountId = "string",
        IntegrationType = "string",
        TenantUrl = "string",
        Active = false,
        ReferenceId = "string",
    });
    
    example, err := cloudflare.NewZeroTrustRiskScoreIntegration(ctx, "zeroTrustRiskScoreIntegrationResource", &cloudflare.ZeroTrustRiskScoreIntegrationArgs{
    	AccountId:       pulumi.String("string"),
    	IntegrationType: pulumi.String("string"),
    	TenantUrl:       pulumi.String("string"),
    	Active:          pulumi.Bool(false),
    	ReferenceId:     pulumi.String("string"),
    })
    
    var zeroTrustRiskScoreIntegrationResource = new ZeroTrustRiskScoreIntegration("zeroTrustRiskScoreIntegrationResource", ZeroTrustRiskScoreIntegrationArgs.builder()
        .accountId("string")
        .integrationType("string")
        .tenantUrl("string")
        .active(false)
        .referenceId("string")
        .build());
    
    zero_trust_risk_score_integration_resource = cloudflare.ZeroTrustRiskScoreIntegration("zeroTrustRiskScoreIntegrationResource",
        account_id="string",
        integration_type="string",
        tenant_url="string",
        active=False,
        reference_id="string")
    
    const zeroTrustRiskScoreIntegrationResource = new cloudflare.ZeroTrustRiskScoreIntegration("zeroTrustRiskScoreIntegrationResource", {
        accountId: "string",
        integrationType: "string",
        tenantUrl: "string",
        active: false,
        referenceId: "string",
    });
    
    type: cloudflare:ZeroTrustRiskScoreIntegration
    properties:
        accountId: string
        active: false
        integrationType: string
        referenceId: string
        tenantUrl: string
    

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

    AccountId string
    The account identifier to target for the resource.
    IntegrationType string
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    TenantUrl string
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    Active bool
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    ReferenceId string
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    AccountId string
    The account identifier to target for the resource.
    IntegrationType string
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    TenantUrl string
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    Active bool
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    ReferenceId string
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    accountId String
    The account identifier to target for the resource.
    integrationType String
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    tenantUrl String
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    active Boolean
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    referenceId String
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    accountId string
    The account identifier to target for the resource.
    integrationType string
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    tenantUrl string
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    active boolean
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    referenceId string
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    account_id str
    The account identifier to target for the resource.
    integration_type str
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    tenant_url str
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    active bool
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    reference_id str
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    accountId String
    The account identifier to target for the resource.
    integrationType String
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    tenantUrl String
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    active Boolean
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    referenceId String
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ZeroTrustRiskScoreIntegration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    WellKnownUrl string
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    Id string
    The provider-assigned unique ID for this managed resource.
    WellKnownUrl string
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    id String
    The provider-assigned unique ID for this managed resource.
    wellKnownUrl String
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    id string
    The provider-assigned unique ID for this managed resource.
    wellKnownUrl string
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    id str
    The provider-assigned unique ID for this managed resource.
    well_known_url str
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    id String
    The provider-assigned unique ID for this managed resource.
    wellKnownUrl String
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1

    Look up Existing ZeroTrustRiskScoreIntegration Resource

    Get an existing ZeroTrustRiskScoreIntegration 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?: ZeroTrustRiskScoreIntegrationState, opts?: CustomResourceOptions): ZeroTrustRiskScoreIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            active: Optional[bool] = None,
            integration_type: Optional[str] = None,
            reference_id: Optional[str] = None,
            tenant_url: Optional[str] = None,
            well_known_url: Optional[str] = None) -> ZeroTrustRiskScoreIntegration
    func GetZeroTrustRiskScoreIntegration(ctx *Context, name string, id IDInput, state *ZeroTrustRiskScoreIntegrationState, opts ...ResourceOption) (*ZeroTrustRiskScoreIntegration, error)
    public static ZeroTrustRiskScoreIntegration Get(string name, Input<string> id, ZeroTrustRiskScoreIntegrationState? state, CustomResourceOptions? opts = null)
    public static ZeroTrustRiskScoreIntegration get(String name, Output<String> id, ZeroTrustRiskScoreIntegrationState 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.
    The following state arguments are supported:
    AccountId string
    The account identifier to target for the resource.
    Active bool
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    IntegrationType string
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    ReferenceId string
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    TenantUrl string
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    WellKnownUrl string
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    AccountId string
    The account identifier to target for the resource.
    Active bool
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    IntegrationType string
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    ReferenceId string
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    TenantUrl string
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    WellKnownUrl string
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    accountId String
    The account identifier to target for the resource.
    active Boolean
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    integrationType String
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    referenceId String
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    tenantUrl String
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    wellKnownUrl String
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    accountId string
    The account identifier to target for the resource.
    active boolean
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    integrationType string
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    referenceId string
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    tenantUrl string
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    wellKnownUrl string
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    account_id str
    The account identifier to target for the resource.
    active bool
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    integration_type str
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    reference_id str
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    tenant_url str
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    well_known_url str
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1
    accountId String
    The account identifier to target for the resource.
    active Boolean
    Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
    integrationType String
    The type of integration, e.g. 'Okta'. Full list of allowed values can be found here: https://developers.cloudflare.com/api/operations/dlp-zt-risk-score-integration-create#request-body
    referenceId String
    A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). If omitted, a random UUIDv4 is used. https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
    tenantUrl String
    The base url of the tenant, e.g. 'https://tenant.okta.com'. Must be your Okta Tenant URL and not your custom domain.
    wellKnownUrl String
    The URL for the Shared Signals Framework configuration, e.g. '/.well-known/sse-configuration/{integrationuuid}/'. https://openid.net/specs/openid-sse-framework-10.html#rfc.section.6.2.1

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi