Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Restapi Provider
  3. API Docs
  4. Provider
restapi 2.0.1 published on Tuesday, Apr 15, 2025 by mastercard
mastercard/terraform-provider-restapi

restapi.Provider

Explore with Pulumi AI

restapi logo
restapi 2.0.1 published on Tuesday, Apr 15, 2025 by mastercard
mastercard/terraform-provider-restapi

    The provider type for the restapi package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

    new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cert_file: Optional[str] = None,
             cert_string: Optional[str] = None,
             copy_keys: Optional[Sequence[str]] = None,
             create_method: Optional[str] = None,
             create_returns_object: Optional[bool] = None,
             debug: Optional[bool] = None,
             destroy_method: Optional[str] = None,
             headers: Optional[Mapping[str, str]] = None,
             id_attribute: Optional[str] = None,
             insecure: Optional[bool] = None,
             key_file: Optional[str] = None,
             key_string: Optional[str] = None,
             oauth_client_credentials: Optional[ProviderOauthClientCredentialsArgs] = None,
             password: Optional[str] = None,
             rate_limit: Optional[float] = None,
             read_method: Optional[str] = None,
             root_ca_file: Optional[str] = None,
             root_ca_string: Optional[str] = None,
             test_path: Optional[str] = None,
             timeout: Optional[float] = None,
             update_method: Optional[str] = None,
             uri: Optional[str] = None,
             use_cookies: Optional[bool] = None,
             username: Optional[str] = None,
             write_returns_object: Optional[bool] = None,
             xssi_prefix: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:restapi
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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Uri string
    URI of the REST API endpoint. This serves as the base of all requests.
    CertFile string
    When set with the key_file parameter, the provider will load a client certificate as a file for mTLS authentication.
    CertString string
    When set with the key_string parameter, the provider will load a client certificate as a string for mTLS authentication.
    CopyKeys List<string>
    When set, any PUT to the API for an object will copy these keys from the data the provider has gathered about the object. This is useful if internal API information must also be provided with updates, such as the revision of the object.
    CreateMethod string
    Defaults to POST. The HTTP method used to CREATE objects of this type on the API server.
    CreateReturnsObject bool
    Set this when the API returns the object created only on creation operations (POST). This is used by the provider to refresh internal data structures.
    Debug bool
    Enabling this will cause lots of debug information to be printed to STDOUT by the API client.
    DestroyMethod string
    Defaults to DELETE. The HTTP method used to DELETE objects of this type on the API server.
    Headers Dictionary<string, string>
    A map of header names and values to set on all outbound requests. This is useful if you want to use a script via the 'external' provider or provide a pre-approved token or change Content-Type from application/json. If username and password are set and Authorization is one of the headers defined here, the BASIC auth credentials take precedence.
    IdAttribute string
    When set, this key will be used to operate on REST objects. For example, if the ID is set to 'name', changes to the API object will be to http://foo.com/bar/VALUE_OF_NAME. This value may also be a '/'-delimeted path to the id attribute if it is multple levels deep in the data (such as attributes/id in the case of an object { "attributes": { "id": 1234 }, "config": { "name": "foo", "something": "bar"}}
    Insecure bool
    When using https, this disables TLS verification of the host.
    KeyFile string
    When set with the cert_file parameter, the provider will load a client certificate as a file for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    KeyString string
    When set with the cert_string parameter, the provider will load a client certificate as a string for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    OauthClientCredentials ProviderOauthClientCredentials
    Configuration for oauth client credential flow using the https://pkg.go.dev/golang.org/x/oauth2 implementation
    Password string
    When set, will use this password for BASIC auth to the API.
    RateLimit double
    Set this to limit the number of requests per second made to the API.
    ReadMethod string
    Defaults to GET. The HTTP method used to READ objects of this type on the API server.
    RootCaFile string
    When set, the provider will load a root CA certificate as a file for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    RootCaString string
    When set, the provider will load a root CA certificate as a string for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    TestPath string
    If set, the provider will issue a read_method request to this path after instantiation requiring a 200 OK response before proceeding. This is useful if your API provides a no-op endpoint that can signal if this provider is configured correctly. Response data will be ignored.
    Timeout double
    When set, will cause requests taking longer than this time (in seconds) to be aborted.
    UpdateMethod string
    Defaults to PUT. The HTTP method used to UPDATE objects of this type on the API server.
    UseCookies bool
    Enable cookie jar to persist session.
    Username string
    When set, will use this username for BASIC auth to the API.
    WriteReturnsObject bool
    Set this when the API returns the object created on all write operations (POST, PUT). This is used by the provider to refresh internal data structures.
    XssiPrefix string
    Trim the xssi prefix from response string, if present, before parsing.
    Uri string
    URI of the REST API endpoint. This serves as the base of all requests.
    CertFile string
    When set with the key_file parameter, the provider will load a client certificate as a file for mTLS authentication.
    CertString string
    When set with the key_string parameter, the provider will load a client certificate as a string for mTLS authentication.
    CopyKeys []string
    When set, any PUT to the API for an object will copy these keys from the data the provider has gathered about the object. This is useful if internal API information must also be provided with updates, such as the revision of the object.
    CreateMethod string
    Defaults to POST. The HTTP method used to CREATE objects of this type on the API server.
    CreateReturnsObject bool
    Set this when the API returns the object created only on creation operations (POST). This is used by the provider to refresh internal data structures.
    Debug bool
    Enabling this will cause lots of debug information to be printed to STDOUT by the API client.
    DestroyMethod string
    Defaults to DELETE. The HTTP method used to DELETE objects of this type on the API server.
    Headers map[string]string
    A map of header names and values to set on all outbound requests. This is useful if you want to use a script via the 'external' provider or provide a pre-approved token or change Content-Type from application/json. If username and password are set and Authorization is one of the headers defined here, the BASIC auth credentials take precedence.
    IdAttribute string
    When set, this key will be used to operate on REST objects. For example, if the ID is set to 'name', changes to the API object will be to http://foo.com/bar/VALUE_OF_NAME. This value may also be a '/'-delimeted path to the id attribute if it is multple levels deep in the data (such as attributes/id in the case of an object { "attributes": { "id": 1234 }, "config": { "name": "foo", "something": "bar"}}
    Insecure bool
    When using https, this disables TLS verification of the host.
    KeyFile string
    When set with the cert_file parameter, the provider will load a client certificate as a file for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    KeyString string
    When set with the cert_string parameter, the provider will load a client certificate as a string for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    OauthClientCredentials ProviderOauthClientCredentialsArgs
    Configuration for oauth client credential flow using the https://pkg.go.dev/golang.org/x/oauth2 implementation
    Password string
    When set, will use this password for BASIC auth to the API.
    RateLimit float64
    Set this to limit the number of requests per second made to the API.
    ReadMethod string
    Defaults to GET. The HTTP method used to READ objects of this type on the API server.
    RootCaFile string
    When set, the provider will load a root CA certificate as a file for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    RootCaString string
    When set, the provider will load a root CA certificate as a string for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    TestPath string
    If set, the provider will issue a read_method request to this path after instantiation requiring a 200 OK response before proceeding. This is useful if your API provides a no-op endpoint that can signal if this provider is configured correctly. Response data will be ignored.
    Timeout float64
    When set, will cause requests taking longer than this time (in seconds) to be aborted.
    UpdateMethod string
    Defaults to PUT. The HTTP method used to UPDATE objects of this type on the API server.
    UseCookies bool
    Enable cookie jar to persist session.
    Username string
    When set, will use this username for BASIC auth to the API.
    WriteReturnsObject bool
    Set this when the API returns the object created on all write operations (POST, PUT). This is used by the provider to refresh internal data structures.
    XssiPrefix string
    Trim the xssi prefix from response string, if present, before parsing.
    uri String
    URI of the REST API endpoint. This serves as the base of all requests.
    certFile String
    When set with the key_file parameter, the provider will load a client certificate as a file for mTLS authentication.
    certString String
    When set with the key_string parameter, the provider will load a client certificate as a string for mTLS authentication.
    copyKeys List<String>
    When set, any PUT to the API for an object will copy these keys from the data the provider has gathered about the object. This is useful if internal API information must also be provided with updates, such as the revision of the object.
    createMethod String
    Defaults to POST. The HTTP method used to CREATE objects of this type on the API server.
    createReturnsObject Boolean
    Set this when the API returns the object created only on creation operations (POST). This is used by the provider to refresh internal data structures.
    debug Boolean
    Enabling this will cause lots of debug information to be printed to STDOUT by the API client.
    destroyMethod String
    Defaults to DELETE. The HTTP method used to DELETE objects of this type on the API server.
    headers Map<String,String>
    A map of header names and values to set on all outbound requests. This is useful if you want to use a script via the 'external' provider or provide a pre-approved token or change Content-Type from application/json. If username and password are set and Authorization is one of the headers defined here, the BASIC auth credentials take precedence.
    idAttribute String
    When set, this key will be used to operate on REST objects. For example, if the ID is set to 'name', changes to the API object will be to http://foo.com/bar/VALUE_OF_NAME. This value may also be a '/'-delimeted path to the id attribute if it is multple levels deep in the data (such as attributes/id in the case of an object { "attributes": { "id": 1234 }, "config": { "name": "foo", "something": "bar"}}
    insecure Boolean
    When using https, this disables TLS verification of the host.
    keyFile String
    When set with the cert_file parameter, the provider will load a client certificate as a file for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    keyString String
    When set with the cert_string parameter, the provider will load a client certificate as a string for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    oauthClientCredentials ProviderOauthClientCredentials
    Configuration for oauth client credential flow using the https://pkg.go.dev/golang.org/x/oauth2 implementation
    password String
    When set, will use this password for BASIC auth to the API.
    rateLimit Double
    Set this to limit the number of requests per second made to the API.
    readMethod String
    Defaults to GET. The HTTP method used to READ objects of this type on the API server.
    rootCaFile String
    When set, the provider will load a root CA certificate as a file for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    rootCaString String
    When set, the provider will load a root CA certificate as a string for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    testPath String
    If set, the provider will issue a read_method request to this path after instantiation requiring a 200 OK response before proceeding. This is useful if your API provides a no-op endpoint that can signal if this provider is configured correctly. Response data will be ignored.
    timeout Double
    When set, will cause requests taking longer than this time (in seconds) to be aborted.
    updateMethod String
    Defaults to PUT. The HTTP method used to UPDATE objects of this type on the API server.
    useCookies Boolean
    Enable cookie jar to persist session.
    username String
    When set, will use this username for BASIC auth to the API.
    writeReturnsObject Boolean
    Set this when the API returns the object created on all write operations (POST, PUT). This is used by the provider to refresh internal data structures.
    xssiPrefix String
    Trim the xssi prefix from response string, if present, before parsing.
    uri string
    URI of the REST API endpoint. This serves as the base of all requests.
    certFile string
    When set with the key_file parameter, the provider will load a client certificate as a file for mTLS authentication.
    certString string
    When set with the key_string parameter, the provider will load a client certificate as a string for mTLS authentication.
    copyKeys string[]
    When set, any PUT to the API for an object will copy these keys from the data the provider has gathered about the object. This is useful if internal API information must also be provided with updates, such as the revision of the object.
    createMethod string
    Defaults to POST. The HTTP method used to CREATE objects of this type on the API server.
    createReturnsObject boolean
    Set this when the API returns the object created only on creation operations (POST). This is used by the provider to refresh internal data structures.
    debug boolean
    Enabling this will cause lots of debug information to be printed to STDOUT by the API client.
    destroyMethod string
    Defaults to DELETE. The HTTP method used to DELETE objects of this type on the API server.
    headers {[key: string]: string}
    A map of header names and values to set on all outbound requests. This is useful if you want to use a script via the 'external' provider or provide a pre-approved token or change Content-Type from application/json. If username and password are set and Authorization is one of the headers defined here, the BASIC auth credentials take precedence.
    idAttribute string
    When set, this key will be used to operate on REST objects. For example, if the ID is set to 'name', changes to the API object will be to http://foo.com/bar/VALUE_OF_NAME. This value may also be a '/'-delimeted path to the id attribute if it is multple levels deep in the data (such as attributes/id in the case of an object { "attributes": { "id": 1234 }, "config": { "name": "foo", "something": "bar"}}
    insecure boolean
    When using https, this disables TLS verification of the host.
    keyFile string
    When set with the cert_file parameter, the provider will load a client certificate as a file for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    keyString string
    When set with the cert_string parameter, the provider will load a client certificate as a string for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    oauthClientCredentials ProviderOauthClientCredentials
    Configuration for oauth client credential flow using the https://pkg.go.dev/golang.org/x/oauth2 implementation
    password string
    When set, will use this password for BASIC auth to the API.
    rateLimit number
    Set this to limit the number of requests per second made to the API.
    readMethod string
    Defaults to GET. The HTTP method used to READ objects of this type on the API server.
    rootCaFile string
    When set, the provider will load a root CA certificate as a file for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    rootCaString string
    When set, the provider will load a root CA certificate as a string for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    testPath string
    If set, the provider will issue a read_method request to this path after instantiation requiring a 200 OK response before proceeding. This is useful if your API provides a no-op endpoint that can signal if this provider is configured correctly. Response data will be ignored.
    timeout number
    When set, will cause requests taking longer than this time (in seconds) to be aborted.
    updateMethod string
    Defaults to PUT. The HTTP method used to UPDATE objects of this type on the API server.
    useCookies boolean
    Enable cookie jar to persist session.
    username string
    When set, will use this username for BASIC auth to the API.
    writeReturnsObject boolean
    Set this when the API returns the object created on all write operations (POST, PUT). This is used by the provider to refresh internal data structures.
    xssiPrefix string
    Trim the xssi prefix from response string, if present, before parsing.
    uri str
    URI of the REST API endpoint. This serves as the base of all requests.
    cert_file str
    When set with the key_file parameter, the provider will load a client certificate as a file for mTLS authentication.
    cert_string str
    When set with the key_string parameter, the provider will load a client certificate as a string for mTLS authentication.
    copy_keys Sequence[str]
    When set, any PUT to the API for an object will copy these keys from the data the provider has gathered about the object. This is useful if internal API information must also be provided with updates, such as the revision of the object.
    create_method str
    Defaults to POST. The HTTP method used to CREATE objects of this type on the API server.
    create_returns_object bool
    Set this when the API returns the object created only on creation operations (POST). This is used by the provider to refresh internal data structures.
    debug bool
    Enabling this will cause lots of debug information to be printed to STDOUT by the API client.
    destroy_method str
    Defaults to DELETE. The HTTP method used to DELETE objects of this type on the API server.
    headers Mapping[str, str]
    A map of header names and values to set on all outbound requests. This is useful if you want to use a script via the 'external' provider or provide a pre-approved token or change Content-Type from application/json. If username and password are set and Authorization is one of the headers defined here, the BASIC auth credentials take precedence.
    id_attribute str
    When set, this key will be used to operate on REST objects. For example, if the ID is set to 'name', changes to the API object will be to http://foo.com/bar/VALUE_OF_NAME. This value may also be a '/'-delimeted path to the id attribute if it is multple levels deep in the data (such as attributes/id in the case of an object { "attributes": { "id": 1234 }, "config": { "name": "foo", "something": "bar"}}
    insecure bool
    When using https, this disables TLS verification of the host.
    key_file str
    When set with the cert_file parameter, the provider will load a client certificate as a file for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    key_string str
    When set with the cert_string parameter, the provider will load a client certificate as a string for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    oauth_client_credentials ProviderOauthClientCredentialsArgs
    Configuration for oauth client credential flow using the https://pkg.go.dev/golang.org/x/oauth2 implementation
    password str
    When set, will use this password for BASIC auth to the API.
    rate_limit float
    Set this to limit the number of requests per second made to the API.
    read_method str
    Defaults to GET. The HTTP method used to READ objects of this type on the API server.
    root_ca_file str
    When set, the provider will load a root CA certificate as a file for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    root_ca_string str
    When set, the provider will load a root CA certificate as a string for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    test_path str
    If set, the provider will issue a read_method request to this path after instantiation requiring a 200 OK response before proceeding. This is useful if your API provides a no-op endpoint that can signal if this provider is configured correctly. Response data will be ignored.
    timeout float
    When set, will cause requests taking longer than this time (in seconds) to be aborted.
    update_method str
    Defaults to PUT. The HTTP method used to UPDATE objects of this type on the API server.
    use_cookies bool
    Enable cookie jar to persist session.
    username str
    When set, will use this username for BASIC auth to the API.
    write_returns_object bool
    Set this when the API returns the object created on all write operations (POST, PUT). This is used by the provider to refresh internal data structures.
    xssi_prefix str
    Trim the xssi prefix from response string, if present, before parsing.
    uri String
    URI of the REST API endpoint. This serves as the base of all requests.
    certFile String
    When set with the key_file parameter, the provider will load a client certificate as a file for mTLS authentication.
    certString String
    When set with the key_string parameter, the provider will load a client certificate as a string for mTLS authentication.
    copyKeys List<String>
    When set, any PUT to the API for an object will copy these keys from the data the provider has gathered about the object. This is useful if internal API information must also be provided with updates, such as the revision of the object.
    createMethod String
    Defaults to POST. The HTTP method used to CREATE objects of this type on the API server.
    createReturnsObject Boolean
    Set this when the API returns the object created only on creation operations (POST). This is used by the provider to refresh internal data structures.
    debug Boolean
    Enabling this will cause lots of debug information to be printed to STDOUT by the API client.
    destroyMethod String
    Defaults to DELETE. The HTTP method used to DELETE objects of this type on the API server.
    headers Map<String>
    A map of header names and values to set on all outbound requests. This is useful if you want to use a script via the 'external' provider or provide a pre-approved token or change Content-Type from application/json. If username and password are set and Authorization is one of the headers defined here, the BASIC auth credentials take precedence.
    idAttribute String
    When set, this key will be used to operate on REST objects. For example, if the ID is set to 'name', changes to the API object will be to http://foo.com/bar/VALUE_OF_NAME. This value may also be a '/'-delimeted path to the id attribute if it is multple levels deep in the data (such as attributes/id in the case of an object { "attributes": { "id": 1234 }, "config": { "name": "foo", "something": "bar"}}
    insecure Boolean
    When using https, this disables TLS verification of the host.
    keyFile String
    When set with the cert_file parameter, the provider will load a client certificate as a file for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    keyString String
    When set with the cert_string parameter, the provider will load a client certificate as a string for mTLS authentication. Note that this mechanism simply delegates to golang's tls.LoadX509KeyPair which does not support passphrase protected private keys. The most robust security protections available to the key_file are simple file system permissions.
    oauthClientCredentials Property Map
    Configuration for oauth client credential flow using the https://pkg.go.dev/golang.org/x/oauth2 implementation
    password String
    When set, will use this password for BASIC auth to the API.
    rateLimit Number
    Set this to limit the number of requests per second made to the API.
    readMethod String
    Defaults to GET. The HTTP method used to READ objects of this type on the API server.
    rootCaFile String
    When set, the provider will load a root CA certificate as a file for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    rootCaString String
    When set, the provider will load a root CA certificate as a string for mTLS authentication. This is useful when the API server is using a self-signed certificate and the client needs to trust it.
    testPath String
    If set, the provider will issue a read_method request to this path after instantiation requiring a 200 OK response before proceeding. This is useful if your API provides a no-op endpoint that can signal if this provider is configured correctly. Response data will be ignored.
    timeout Number
    When set, will cause requests taking longer than this time (in seconds) to be aborted.
    updateMethod String
    Defaults to PUT. The HTTP method used to UPDATE objects of this type on the API server.
    useCookies Boolean
    Enable cookie jar to persist session.
    username String
    When set, will use this username for BASIC auth to the API.
    writeReturnsObject Boolean
    Set this when the API returns the object created on all write operations (POST, PUT). This is used by the provider to refresh internal data structures.
    xssiPrefix String
    Trim the xssi prefix from response string, if present, before parsing.

    Outputs

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

    Supporting Types

    ProviderOauthClientCredentials, ProviderOauthClientCredentialsArgs

    OauthClientId string
    client id
    OauthClientSecret string
    client secret
    OauthTokenEndpoint string
    oauth token endpoint
    EndpointParams Dictionary<string, string>
    Additional key/values to pass to the underlying Oauth client library (as EndpointParams)
    OauthScopes List<string>
    scopes
    OauthClientId string
    client id
    OauthClientSecret string
    client secret
    OauthTokenEndpoint string
    oauth token endpoint
    EndpointParams map[string]string
    Additional key/values to pass to the underlying Oauth client library (as EndpointParams)
    OauthScopes []string
    scopes
    oauthClientId String
    client id
    oauthClientSecret String
    client secret
    oauthTokenEndpoint String
    oauth token endpoint
    endpointParams Map<String,String>
    Additional key/values to pass to the underlying Oauth client library (as EndpointParams)
    oauthScopes List<String>
    scopes
    oauthClientId string
    client id
    oauthClientSecret string
    client secret
    oauthTokenEndpoint string
    oauth token endpoint
    endpointParams {[key: string]: string}
    Additional key/values to pass to the underlying Oauth client library (as EndpointParams)
    oauthScopes string[]
    scopes
    oauth_client_id str
    client id
    oauth_client_secret str
    client secret
    oauth_token_endpoint str
    oauth token endpoint
    endpoint_params Mapping[str, str]
    Additional key/values to pass to the underlying Oauth client library (as EndpointParams)
    oauth_scopes Sequence[str]
    scopes
    oauthClientId String
    client id
    oauthClientSecret String
    client secret
    oauthTokenEndpoint String
    oauth token endpoint
    endpointParams Map<String>
    Additional key/values to pass to the underlying Oauth client library (as EndpointParams)
    oauthScopes List<String>
    scopes

    Package Details

    Repository
    restapi mastercard/terraform-provider-restapi
    License
    Notes
    This Pulumi package is based on the restapi Terraform Provider.
    restapi logo
    restapi 2.0.1 published on Tuesday, Apr 15, 2025 by mastercard
    mastercard/terraform-provider-restapi