Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. ApiClient
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.ApiClient

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as commercetools from "@pulumi/commercetools";

const my_api_client = new commercetools.ApiClient("my-api-client", {scopes: [
    "manage_orders:my-ct-project-key",
    "manage_payments:my-ct-project-key",
]});

    import pulumi
import pulumi_commercetools as commercetools

my_api_client = commercetools.ApiClient("my-api-client", scopes=[
    "manage_orders:my-ct-project-key",
    "manage_payments:my-ct-project-key",
])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := commercetools.NewApiClient(ctx, "my-api-client", &commercetools.ApiClientArgs{
			Scopes: pulumi.StringArray{
				pulumi.String("manage_orders:my-ct-project-key"),
				pulumi.String("manage_payments:my-ct-project-key"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;

return await Deployment.RunAsync(() => 
{
    var my_api_client = new Commercetools.ApiClient("my-api-client", new()
    {
        Scopes = new[]
        {
            "manage_orders:my-ct-project-key",
            "manage_payments:my-ct-project-key",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.ApiClient;
import com.pulumi.commercetools.ApiClientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_api_client = new ApiClient("my-api-client", ApiClientArgs.builder()
            .scopes(            
                "manage_orders:my-ct-project-key",
                "manage_payments:my-ct-project-key")
            .build());

    }
}

    resources:
  my-api-client:
    type: commercetools:ApiClient
    properties:
      scopes:
        - manage_orders:my-ct-project-key
        - manage_payments:my-ct-project-key

    Create ApiClient Resource

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

    Constructor syntax

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

@overload
def ApiClient(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              scopes: Optional[Sequence[str]] = None,
              access_token_validity_seconds: Optional[float] = None,
              api_client_id: Optional[str] = None,
              name: Optional[str] = None,
              refresh_token_validity_seconds: Optional[float] = None)
    func NewApiClient(ctx *Context, name string, args ApiClientArgs, opts ...ResourceOption) (*ApiClient, error)
    public ApiClient(string name, ApiClientArgs args, CustomResourceOptions? opts = null)
    public ApiClient(String name, ApiClientArgs args)
public ApiClient(String name, ApiClientArgs args, CustomResourceOptions options)

    type: commercetools:ApiClient
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 ApiClientArgs
    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 ApiClientArgs
    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 ApiClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiClientArgs
    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 apiClientResource = new Commercetools.ApiClient("apiClientResource", new()
{
    Scopes = new[]
    {
        "string",
    },
    AccessTokenValiditySeconds = 0,
    ApiClientId = "string",
    Name = "string",
    RefreshTokenValiditySeconds = 0,
});

    example, err := commercetools.NewApiClient(ctx, "apiClientResource", &commercetools.ApiClientArgs{
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
AccessTokenValiditySeconds: pulumi.Float64(0),
ApiClientId: pulumi.String("string"),
Name: pulumi.String("string"),
RefreshTokenValiditySeconds: pulumi.Float64(0),
})

    var apiClientResource = new ApiClient("apiClientResource", ApiClientArgs.builder()
    .scopes("string")
    .accessTokenValiditySeconds(0)
    .apiClientId("string")
    .name("string")
    .refreshTokenValiditySeconds(0)
    .build());

    api_client_resource = commercetools.ApiClient("apiClientResource",
    scopes=["string"],
    access_token_validity_seconds=0,
    api_client_id="string",
    name="string",
    refresh_token_validity_seconds=0)

    const apiClientResource = new commercetools.ApiClient("apiClientResource", {
    scopes: ["string"],
    accessTokenValiditySeconds: 0,
    apiClientId: "string",
    name: "string",
    refreshTokenValiditySeconds: 0,
});

    type: commercetools:ApiClient
properties:
    accessTokenValiditySeconds: 0
    apiClientId: string
    name: string
    refreshTokenValiditySeconds: 0
    scopes:
        - string

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

    Scopes List<string>
    A list of the OAuth scopes
    AccessTokenValiditySeconds double
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    ApiClientId string
    The ID of this resource.
    Name string
    Name of the API client
    RefreshTokenValiditySeconds double
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    Scopes []string
    A list of the OAuth scopes
    AccessTokenValiditySeconds float64
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    ApiClientId string
    The ID of this resource.
    Name string
    Name of the API client
    RefreshTokenValiditySeconds float64
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes List<String>
    A list of the OAuth scopes
    accessTokenValiditySeconds Double
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    apiClientId String
    The ID of this resource.
    name String
    Name of the API client
    refreshTokenValiditySeconds Double
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes string[]
    A list of the OAuth scopes
    accessTokenValiditySeconds number
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    apiClientId string
    The ID of this resource.
    name string
    Name of the API client
    refreshTokenValiditySeconds number
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes Sequence[str]
    A list of the OAuth scopes
    access_token_validity_seconds float
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    api_client_id str
    The ID of this resource.
    name str
    Name of the API client
    refresh_token_validity_seconds float
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes List<String>
    A list of the OAuth scopes
    accessTokenValiditySeconds Number
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    apiClientId String
    The ID of this resource.
    name String
    Name of the API client
    refreshTokenValiditySeconds Number
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Secret string
    Id string
    The provider-assigned unique ID for this managed resource.
    Secret string
    id String
    The provider-assigned unique ID for this managed resource.
    secret String
    id string
    The provider-assigned unique ID for this managed resource.
    secret string
    id str
    The provider-assigned unique ID for this managed resource.
    secret str
    id String
    The provider-assigned unique ID for this managed resource.
    secret String

    Look up Existing ApiClient Resource

    Get an existing ApiClient 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?: ApiClientState, opts?: CustomResourceOptions): ApiClient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_token_validity_seconds: Optional[float] = None,
        api_client_id: Optional[str] = None,
        name: Optional[str] = None,
        refresh_token_validity_seconds: Optional[float] = None,
        scopes: Optional[Sequence[str]] = None,
        secret: Optional[str] = None) -> ApiClient
    func GetApiClient(ctx *Context, name string, id IDInput, state *ApiClientState, opts ...ResourceOption) (*ApiClient, error)
    public static ApiClient Get(string name, Input<string> id, ApiClientState? state, CustomResourceOptions? opts = null)
    public static ApiClient get(String name, Output<String> id, ApiClientState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:ApiClient    get:      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:
    AccessTokenValiditySeconds double
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    ApiClientId string
    The ID of this resource.
    Name string
    Name of the API client
    RefreshTokenValiditySeconds double
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    Scopes List<string>
    A list of the OAuth scopes
    Secret string
    AccessTokenValiditySeconds float64
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    ApiClientId string
    The ID of this resource.
    Name string
    Name of the API client
    RefreshTokenValiditySeconds float64
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    Scopes []string
    A list of the OAuth scopes
    Secret string
    accessTokenValiditySeconds Double
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    apiClientId String
    The ID of this resource.
    name String
    Name of the API client
    refreshTokenValiditySeconds Double
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes List<String>
    A list of the OAuth scopes
    secret String
    accessTokenValiditySeconds number
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    apiClientId string
    The ID of this resource.
    name string
    Name of the API client
    refreshTokenValiditySeconds number
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes string[]
    A list of the OAuth scopes
    secret string
    access_token_validity_seconds float
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    api_client_id str
    The ID of this resource.
    name str
    Name of the API client
    refresh_token_validity_seconds float
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes Sequence[str]
    A list of the OAuth scopes
    secret str
    accessTokenValiditySeconds Number
    Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    apiClientId String
    The ID of this resource.
    name String
    Name of the API client
    refreshTokenValiditySeconds Number
    Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.
    scopes List<String>
    A list of the OAuth scopes
    secret String

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools