1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. ScimConnector
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a Outbound SCIM connector and its configuration in a Descope project. Provision users and groups to an external system through the SCIM protocol.

    Create ScimConnector Resource

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

    Constructor syntax

    new ScimConnector(name: string, args: ScimConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def ScimConnector(resource_name: str,
                      args: ScimConnectorArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScimConnector(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      base_url: Optional[str] = None,
                      federated_app_id: Optional[str] = None,
                      project_id: Optional[str] = None,
                      authentication: Optional[ScimConnectorAuthenticationArgs] = None,
                      description: Optional[str] = None,
                      disabled: Optional[bool] = None,
                      headers: Optional[Mapping[str, str]] = None,
                      hmac_secret: Optional[str] = None,
                      insecure: Optional[bool] = None,
                      name: Optional[str] = None,
                      secret_headers: Optional[Mapping[str, str]] = None)
    func NewScimConnector(ctx *Context, name string, args ScimConnectorArgs, opts ...ResourceOption) (*ScimConnector, error)
    public ScimConnector(string name, ScimConnectorArgs args, CustomResourceOptions? opts = null)
    public ScimConnector(String name, ScimConnectorArgs args)
    public ScimConnector(String name, ScimConnectorArgs args, CustomResourceOptions options)
    
    type: descope:ScimConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_scim_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ScimConnectorArgs
    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 ScimConnectorArgs
    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 ScimConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScimConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScimConnectorArgs
    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 scimConnectorResource = new Descope.ScimConnector("scimConnectorResource", new()
    {
        BaseUrl = "string",
        FederatedAppId = "string",
        ProjectId = "string",
        Authentication = new Descope.Inputs.ScimConnectorAuthenticationArgs
        {
            ApiKey = new Descope.Inputs.ScimConnectorAuthenticationApiKeyArgs
            {
                Key = "string",
                Token = "string",
            },
            Basic = new Descope.Inputs.ScimConnectorAuthenticationBasicArgs
            {
                Password = "string",
                Username = "string",
            },
            BearerToken = "string",
            Oauth2ClientCredentials = new Descope.Inputs.ScimConnectorAuthenticationOauth2ClientCredentialsArgs
            {
                AuthUrl = "string",
                ClientId = "string",
                ClientSecret = "string",
                AuthStyle = "string",
                Scopes = "string",
                TokenRequestHeaders = 
                {
                    { "string", "string" },
                },
            },
        },
        Description = "string",
        Disabled = false,
        Headers = 
        {
            { "string", "string" },
        },
        HmacSecret = "string",
        Insecure = false,
        Name = "string",
        SecretHeaders = 
        {
            { "string", "string" },
        },
    });
    
    example, err := descope.NewScimConnector(ctx, "scimConnectorResource", &descope.ScimConnectorArgs{
    	BaseUrl:        pulumi.String("string"),
    	FederatedAppId: pulumi.String("string"),
    	ProjectId:      pulumi.String("string"),
    	Authentication: &descope.ScimConnectorAuthenticationArgs{
    		ApiKey: &descope.ScimConnectorAuthenticationApiKeyArgs{
    			Key:   pulumi.String("string"),
    			Token: pulumi.String("string"),
    		},
    		Basic: &descope.ScimConnectorAuthenticationBasicArgs{
    			Password: pulumi.String("string"),
    			Username: pulumi.String("string"),
    		},
    		BearerToken: pulumi.String("string"),
    		Oauth2ClientCredentials: &descope.ScimConnectorAuthenticationOauth2ClientCredentialsArgs{
    			AuthUrl:      pulumi.String("string"),
    			ClientId:     pulumi.String("string"),
    			ClientSecret: pulumi.String("string"),
    			AuthStyle:    pulumi.String("string"),
    			Scopes:       pulumi.String("string"),
    			TokenRequestHeaders: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    		},
    	},
    	Description: pulumi.String("string"),
    	Disabled:    pulumi.Bool(false),
    	Headers: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	HmacSecret: pulumi.String("string"),
    	Insecure:   pulumi.Bool(false),
    	Name:       pulumi.String("string"),
    	SecretHeaders: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "descope_scim_connector" "scimConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      base_url         = "string"
      federated_app_id = "string"
      project_id       = "string"
      authentication = {
        api_key = {
          key   = "string"
          token = "string"
        }
        basic = {
          password = "string"
          username = "string"
        }
        bearer_token = "string"
        oauth2_client_credentials = {
          auth_url      = "string"
          client_id     = "string"
          client_secret = "string"
          auth_style    = "string"
          scopes        = "string"
          token_request_headers = {
            "string" = "string"
          }
        }
      }
      description = "string"
      disabled    = false
      headers = {
        "string" = "string"
      }
      hmac_secret = "string"
      insecure    = false
      name        = "string"
      secret_headers = {
        "string" = "string"
      }
    }
    
    var scimConnectorResource = new ScimConnector("scimConnectorResource", ScimConnectorArgs.builder()
        .baseUrl("string")
        .federatedAppId("string")
        .projectId("string")
        .authentication(ScimConnectorAuthenticationArgs.builder()
            .apiKey(ScimConnectorAuthenticationApiKeyArgs.builder()
                .key("string")
                .token("string")
                .build())
            .basic(ScimConnectorAuthenticationBasicArgs.builder()
                .password("string")
                .username("string")
                .build())
            .bearerToken("string")
            .oauth2ClientCredentials(ScimConnectorAuthenticationOauth2ClientCredentialsArgs.builder()
                .authUrl("string")
                .clientId("string")
                .clientSecret("string")
                .authStyle("string")
                .scopes("string")
                .tokenRequestHeaders(Map.of("string", "string"))
                .build())
            .build())
        .description("string")
        .disabled(false)
        .headers(Map.of("string", "string"))
        .hmacSecret("string")
        .insecure(false)
        .name("string")
        .secretHeaders(Map.of("string", "string"))
        .build());
    
    scim_connector_resource = descope.ScimConnector("scimConnectorResource",
        base_url="string",
        federated_app_id="string",
        project_id="string",
        authentication={
            "api_key": {
                "key": "string",
                "token": "string",
            },
            "basic": {
                "password": "string",
                "username": "string",
            },
            "bearer_token": "string",
            "oauth2_client_credentials": {
                "auth_url": "string",
                "client_id": "string",
                "client_secret": "string",
                "auth_style": "string",
                "scopes": "string",
                "token_request_headers": {
                    "string": "string",
                },
            },
        },
        description="string",
        disabled=False,
        headers={
            "string": "string",
        },
        hmac_secret="string",
        insecure=False,
        name="string",
        secret_headers={
            "string": "string",
        })
    
    const scimConnectorResource = new descope.ScimConnector("scimConnectorResource", {
        baseUrl: "string",
        federatedAppId: "string",
        projectId: "string",
        authentication: {
            apiKey: {
                key: "string",
                token: "string",
            },
            basic: {
                password: "string",
                username: "string",
            },
            bearerToken: "string",
            oauth2ClientCredentials: {
                authUrl: "string",
                clientId: "string",
                clientSecret: "string",
                authStyle: "string",
                scopes: "string",
                tokenRequestHeaders: {
                    string: "string",
                },
            },
        },
        description: "string",
        disabled: false,
        headers: {
            string: "string",
        },
        hmacSecret: "string",
        insecure: false,
        name: "string",
        secretHeaders: {
            string: "string",
        },
    });
    
    type: descope:ScimConnector
    properties:
        authentication:
            apiKey:
                key: string
                token: string
            basic:
                password: string
                username: string
            bearerToken: string
            oauth2ClientCredentials:
                authStyle: string
                authUrl: string
                clientId: string
                clientSecret: string
                scopes: string
                tokenRequestHeaders:
                    string: string
        baseUrl: string
        description: string
        disabled: false
        federatedAppId: string
        headers:
            string: string
        hmacSecret: string
        insecure: false
        name: string
        projectId: string
        secretHeaders:
            string: string
    

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

    BaseUrl string
    The base URL of the SCIM server that users and groups are provisioned to.
    FederatedAppId string
    The ID of the federated application this SCIM connector provisions for.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Authentication Descope.ScimConnectorAuthentication
    The authentication used when calling the SCIM server.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Headers Dictionary<string, string>
    Additional HTTP headers to send with each request to the SCIM server.
    HmacSecret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    Insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    Name string
    A custom name for your connector.
    SecretHeaders Dictionary<string, string>
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    BaseUrl string
    The base URL of the SCIM server that users and groups are provisioned to.
    FederatedAppId string
    The ID of the federated application this SCIM connector provisions for.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Authentication ScimConnectorAuthenticationArgs
    The authentication used when calling the SCIM server.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Headers map[string]string
    Additional HTTP headers to send with each request to the SCIM server.
    HmacSecret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    Insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    Name string
    A custom name for your connector.
    SecretHeaders map[string]string
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    base_url string
    The base URL of the SCIM server that users and groups are provisioned to.
    federated_app_id string
    The ID of the federated application this SCIM connector provisions for.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    authentication object
    The authentication used when calling the SCIM server.
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    headers map(string)
    Additional HTTP headers to send with each request to the SCIM server.
    hmac_secret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    name string
    A custom name for your connector.
    secret_headers map(string)
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    baseUrl String
    The base URL of the SCIM server that users and groups are provisioned to.
    federatedAppId String
    The ID of the federated application this SCIM connector provisions for.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    authentication ScimConnectorAuthentication
    The authentication used when calling the SCIM server.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    headers Map<String,String>
    Additional HTTP headers to send with each request to the SCIM server.
    hmacSecret String
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure Boolean
    Whether to skip verification of the SCIM server's TLS certificate.
    name String
    A custom name for your connector.
    secretHeaders Map<String,String>
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    baseUrl string
    The base URL of the SCIM server that users and groups are provisioned to.
    federatedAppId string
    The ID of the federated application this SCIM connector provisions for.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    authentication ScimConnectorAuthentication
    The authentication used when calling the SCIM server.
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    headers {[key: string]: string}
    Additional HTTP headers to send with each request to the SCIM server.
    hmacSecret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure boolean
    Whether to skip verification of the SCIM server's TLS certificate.
    name string
    A custom name for your connector.
    secretHeaders {[key: string]: string}
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    base_url str
    The base URL of the SCIM server that users and groups are provisioned to.
    federated_app_id str
    The ID of the federated application this SCIM connector provisions for.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    authentication ScimConnectorAuthenticationArgs
    The authentication used when calling the SCIM server.
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    headers Mapping[str, str]
    Additional HTTP headers to send with each request to the SCIM server.
    hmac_secret str
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    name str
    A custom name for your connector.
    secret_headers Mapping[str, str]
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    baseUrl String
    The base URL of the SCIM server that users and groups are provisioned to.
    federatedAppId String
    The ID of the federated application this SCIM connector provisions for.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    authentication Property Map
    The authentication used when calling the SCIM server.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    headers Map<String>
    Additional HTTP headers to send with each request to the SCIM server.
    hmacSecret String
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure Boolean
    Whether to skip verification of the SCIM server's TLS certificate.
    name String
    A custom name for your connector.
    secretHeaders Map<String>
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScimConnector 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 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 ScimConnector Resource

    Get an existing ScimConnector 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?: ScimConnectorState, opts?: CustomResourceOptions): ScimConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication: Optional[ScimConnectorAuthenticationArgs] = None,
            base_url: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            federated_app_id: Optional[str] = None,
            headers: Optional[Mapping[str, str]] = None,
            hmac_secret: Optional[str] = None,
            insecure: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            secret_headers: Optional[Mapping[str, str]] = None) -> ScimConnector
    func GetScimConnector(ctx *Context, name string, id IDInput, state *ScimConnectorState, opts ...ResourceOption) (*ScimConnector, error)
    public static ScimConnector Get(string name, Input<string> id, ScimConnectorState? state, CustomResourceOptions? opts = null)
    public static ScimConnector get(String name, Output<String> id, ScimConnectorState state, CustomResourceOptions options)
    resources:  _:    type: descope:ScimConnector    get:      id: ${id}
    import {
      to = descope_scim_connector.example
      id = "${id}"
    }
    
    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:
    Authentication Descope.ScimConnectorAuthentication
    The authentication used when calling the SCIM server.
    BaseUrl string
    The base URL of the SCIM server that users and groups are provisioned to.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    FederatedAppId string
    The ID of the federated application this SCIM connector provisions for.
    Headers Dictionary<string, string>
    Additional HTTP headers to send with each request to the SCIM server.
    HmacSecret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    Insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretHeaders Dictionary<string, string>
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    Authentication ScimConnectorAuthenticationArgs
    The authentication used when calling the SCIM server.
    BaseUrl string
    The base URL of the SCIM server that users and groups are provisioned to.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    FederatedAppId string
    The ID of the federated application this SCIM connector provisions for.
    Headers map[string]string
    Additional HTTP headers to send with each request to the SCIM server.
    HmacSecret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    Insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretHeaders map[string]string
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    authentication object
    The authentication used when calling the SCIM server.
    base_url string
    The base URL of the SCIM server that users and groups are provisioned to.
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    federated_app_id string
    The ID of the federated application this SCIM connector provisions for.
    headers map(string)
    Additional HTTP headers to send with each request to the SCIM server.
    hmac_secret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    name string
    A custom name for your connector.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secret_headers map(string)
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    authentication ScimConnectorAuthentication
    The authentication used when calling the SCIM server.
    baseUrl String
    The base URL of the SCIM server that users and groups are provisioned to.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    federatedAppId String
    The ID of the federated application this SCIM connector provisions for.
    headers Map<String,String>
    Additional HTTP headers to send with each request to the SCIM server.
    hmacSecret String
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure Boolean
    Whether to skip verification of the SCIM server's TLS certificate.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretHeaders Map<String,String>
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    authentication ScimConnectorAuthentication
    The authentication used when calling the SCIM server.
    baseUrl string
    The base URL of the SCIM server that users and groups are provisioned to.
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    federatedAppId string
    The ID of the federated application this SCIM connector provisions for.
    headers {[key: string]: string}
    Additional HTTP headers to send with each request to the SCIM server.
    hmacSecret string
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure boolean
    Whether to skip verification of the SCIM server's TLS certificate.
    name string
    A custom name for your connector.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretHeaders {[key: string]: string}
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    authentication ScimConnectorAuthenticationArgs
    The authentication used when calling the SCIM server.
    base_url str
    The base URL of the SCIM server that users and groups are provisioned to.
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    federated_app_id str
    The ID of the federated application this SCIM connector provisions for.
    headers Mapping[str, str]
    Additional HTTP headers to send with each request to the SCIM server.
    hmac_secret str
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure bool
    Whether to skip verification of the SCIM server's TLS certificate.
    name str
    A custom name for your connector.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secret_headers Mapping[str, str]
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    authentication Property Map
    The authentication used when calling the SCIM server.
    baseUrl String
    The base URL of the SCIM server that users and groups are provisioned to.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    federatedAppId String
    The ID of the federated application this SCIM connector provisions for.
    headers Map<String>
    Additional HTTP headers to send with each request to the SCIM server.
    hmacSecret String
    A secret used to sign requests to the SCIM server with an HMAC signature.
    insecure Boolean
    Whether to skip verification of the SCIM server's TLS certificate.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretHeaders Map<String>
    Additional HTTP headers to send with each request to the SCIM server. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.

    Supporting Types

    ScimConnectorAuthentication, ScimConnectorAuthenticationArgs

    ApiKey Descope.ScimConnectorAuthenticationApiKey
    API key authentication configuration.
    Basic Descope.ScimConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    BearerToken string
    Bearer token for HTTP authentication.
    Oauth2ClientCredentials Descope.ScimConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    ApiKey ScimConnectorAuthenticationApiKey
    API key authentication configuration.
    Basic ScimConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    BearerToken string
    Bearer token for HTTP authentication.
    Oauth2ClientCredentials ScimConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    api_key object
    API key authentication configuration.
    basic object
    Basic authentication credentials (username and password).
    bearer_token string
    Bearer token for HTTP authentication.
    oauth2_client_credentials object
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey ScimConnectorAuthenticationApiKey
    API key authentication configuration.
    basic ScimConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearerToken String
    Bearer token for HTTP authentication.
    oauth2ClientCredentials ScimConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey ScimConnectorAuthenticationApiKey
    API key authentication configuration.
    basic ScimConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearerToken string
    Bearer token for HTTP authentication.
    oauth2ClientCredentials ScimConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    api_key ScimConnectorAuthenticationApiKey
    API key authentication configuration.
    basic ScimConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearer_token str
    Bearer token for HTTP authentication.
    oauth2_client_credentials ScimConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey Property Map
    API key authentication configuration.
    basic Property Map
    Basic authentication credentials (username and password).
    bearerToken String
    Bearer token for HTTP authentication.
    oauth2ClientCredentials Property Map
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.

    ScimConnectorAuthenticationApiKey, ScimConnectorAuthenticationApiKeyArgs

    Key string
    The API key.
    Token string
    The API secret.
    Key string
    The API key.
    Token string
    The API secret.
    key string
    The API key.
    token string
    The API secret.
    key String
    The API key.
    token String
    The API secret.
    key string
    The API key.
    token string
    The API secret.
    key str
    The API key.
    token str
    The API secret.
    key String
    The API key.
    token String
    The API secret.

    ScimConnectorAuthenticationBasic, ScimConnectorAuthenticationBasicArgs

    Password string
    Password for basic HTTP authentication.
    Username string
    Username for basic HTTP authentication.
    Password string
    Password for basic HTTP authentication.
    Username string
    Username for basic HTTP authentication.
    password string
    Password for basic HTTP authentication.
    username string
    Username for basic HTTP authentication.
    password String
    Password for basic HTTP authentication.
    username String
    Username for basic HTTP authentication.
    password string
    Password for basic HTTP authentication.
    username string
    Username for basic HTTP authentication.
    password str
    Password for basic HTTP authentication.
    username str
    Username for basic HTTP authentication.
    password String
    Password for basic HTTP authentication.
    username String
    Username for basic HTTP authentication.

    ScimConnectorAuthenticationOauth2ClientCredentials, ScimConnectorAuthenticationOauth2ClientCredentialsArgs

    AuthUrl string
    The token endpoint URL used to request an access token.
    ClientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    ClientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    AuthStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    Scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    TokenRequestHeaders Dictionary<string, string>
    Additional headers to include in the token request sent to the token endpoint.
    AuthUrl string
    The token endpoint URL used to request an access token.
    ClientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    ClientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    AuthStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    Scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    TokenRequestHeaders map[string]string
    Additional headers to include in the token request sent to the token endpoint.
    auth_url string
    The token endpoint URL used to request an access token.
    client_id string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    client_secret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    auth_style string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    token_request_headers map(string)
    Additional headers to include in the token request sent to the token endpoint.
    authUrl String
    The token endpoint URL used to request an access token.
    clientId String
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret String
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle String
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes String
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders Map<String,String>
    Additional headers to include in the token request sent to the token endpoint.
    authUrl string
    The token endpoint URL used to request an access token.
    clientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders {[key: string]: string}
    Additional headers to include in the token request sent to the token endpoint.
    auth_url str
    The token endpoint URL used to request an access token.
    client_id str
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    client_secret str
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    auth_style str
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes str
    A space-separated list of OAuth scopes to request when fetching the access token.
    token_request_headers Mapping[str, str]
    Additional headers to include in the token request sent to the token endpoint.
    authUrl String
    The token endpoint URL used to request an access token.
    clientId String
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret String
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle String
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes String
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders Map<String>
    Additional headers to include in the token request sent to the token endpoint.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial