Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. IamApiClient
Akamai v9.0.0 published on Thursday, Jun 26, 2025 by Pulumi
pulumi/pulumi-akamai

akamai.IamApiClient

Explore with Pulumi AI

akamai logo
Akamai v9.0.0 published on Thursday, Jun 26, 2025 by Pulumi
pulumi/pulumi-akamai

    Create IamApiClient Resource

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

    Constructor syntax

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

@overload
def IamApiClient(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 client_type: Optional[str] = None,
                 api_access: Optional[IamApiClientApiAccessArgs] = None,
                 authorized_users: Optional[Sequence[str]] = None,
                 group_access: Optional[IamApiClientGroupAccessArgs] = None,
                 credential: Optional[IamApiClientCredentialArgs] = None,
                 client_name: Optional[str] = None,
                 can_auto_create_credential: Optional[bool] = None,
                 client_description: Optional[str] = None,
                 allow_account_switch: Optional[bool] = None,
                 ip_acl: Optional[IamApiClientIpAclArgs] = None,
                 lock: Optional[bool] = None,
                 notification_emails: Optional[Sequence[str]] = None,
                 purge_options: Optional[IamApiClientPurgeOptionsArgs] = None)
    func NewIamApiClient(ctx *Context, name string, args IamApiClientArgs, opts ...ResourceOption) (*IamApiClient, error)
    public IamApiClient(string name, IamApiClientArgs args, CustomResourceOptions? opts = null)
    public IamApiClient(String name, IamApiClientArgs args)
public IamApiClient(String name, IamApiClientArgs args, CustomResourceOptions options)

    type: akamai:IamApiClient
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 IamApiClientArgs
    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 IamApiClientArgs
    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 IamApiClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamApiClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamApiClientArgs
    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 iamApiClientResource = new Akamai.IamApiClient("iamApiClientResource", new()
{
    ClientType = "string",
    ApiAccess = new Akamai.Inputs.IamApiClientApiAccessArgs
    {
        AllAccessibleApis = false,
        Apis = new[]
        {
            new Akamai.Inputs.IamApiClientApiAccessApiArgs
            {
                AccessLevel = "string",
                ApiId = 0,
                ApiName = "string",
                Description = "string",
                DocumentationUrl = "string",
                Endpoint = "string",
            },
        },
    },
    AuthorizedUsers = new[]
    {
        "string",
    },
    GroupAccess = new Akamai.Inputs.IamApiClientGroupAccessArgs
    {
        CloneAuthorizedUserGroups = false,
        Groups = new[]
        {
            new Akamai.Inputs.IamApiClientGroupAccessGroupArgs
            {
                GroupId = 0,
                RoleId = 0,
                GroupName = "string",
                IsBlocked = false,
                ParentGroupId = 0,
                RoleDescription = "string",
                RoleName = "string",
                SubGroups = new[]
                {
                    new Akamai.Inputs.IamApiClientGroupAccessGroupSubGroupArgs
                    {
                        GroupId = 0,
                        RoleId = 0,
                        GroupName = "string",
                        IsBlocked = false,
                        ParentGroupId = 0,
                        RoleDescription = "string",
                        RoleName = "string",
                        SubGroups = new[]
                        {
                            iamApiClientGroupAccessGroupSubGroup,
                        },
                    },
                },
            },
        },
    },
    Credential = new Akamai.Inputs.IamApiClientCredentialArgs
    {
        Actions = new Akamai.Inputs.IamApiClientCredentialActionsArgs
        {
            Activate = false,
            Deactivate = false,
            Delete = false,
            EditDescription = false,
            EditExpiration = false,
        },
        ClientSecret = "string",
        ClientToken = "string",
        CreatedOn = "string",
        CredentialId = 0,
        Description = "string",
        ExpiresOn = "string",
        Status = "string",
    },
    ClientName = "string",
    CanAutoCreateCredential = false,
    ClientDescription = "string",
    AllowAccountSwitch = false,
    IpAcl = new Akamai.Inputs.IamApiClientIpAclArgs
    {
        Enable = false,
        Cidrs = new[]
        {
            "string",
        },
    },
    Lock = false,
    NotificationEmails = new[]
    {
        "string",
    },
    PurgeOptions = new Akamai.Inputs.IamApiClientPurgeOptionsArgs
    {
        CanPurgeByCacheTag = false,
        CanPurgeByCpCode = false,
        CpCodeAccess = new Akamai.Inputs.IamApiClientPurgeOptionsCpCodeAccessArgs
        {
            AllCurrentAndNewCpCodes = false,
            CpCodes = new[]
            {
                0,
            },
        },
    },
});

    example, err := akamai.NewIamApiClient(ctx, "iamApiClientResource", &akamai.IamApiClientArgs{
	ClientType: pulumi.String("string"),
	ApiAccess: &akamai.IamApiClientApiAccessArgs{
		AllAccessibleApis: pulumi.Bool(false),
		Apis: akamai.IamApiClientApiAccessApiArray{
			&akamai.IamApiClientApiAccessApiArgs{
				AccessLevel:      pulumi.String("string"),
				ApiId:            pulumi.Int(0),
				ApiName:          pulumi.String("string"),
				Description:      pulumi.String("string"),
				DocumentationUrl: pulumi.String("string"),
				Endpoint:         pulumi.String("string"),
			},
		},
	},
	AuthorizedUsers: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupAccess: &akamai.IamApiClientGroupAccessArgs{
		CloneAuthorizedUserGroups: pulumi.Bool(false),
		Groups: akamai.IamApiClientGroupAccessGroupArray{
			&akamai.IamApiClientGroupAccessGroupArgs{
				GroupId:         pulumi.Int(0),
				RoleId:          pulumi.Int(0),
				GroupName:       pulumi.String("string"),
				IsBlocked:       pulumi.Bool(false),
				ParentGroupId:   pulumi.Int(0),
				RoleDescription: pulumi.String("string"),
				RoleName:        pulumi.String("string"),
				SubGroups: akamai.IamApiClientGroupAccessGroupSubGroupArray{
					&akamai.IamApiClientGroupAccessGroupSubGroupArgs{
						GroupId:         pulumi.Int(0),
						RoleId:          pulumi.Int(0),
						GroupName:       pulumi.String("string"),
						IsBlocked:       pulumi.Bool(false),
						ParentGroupId:   pulumi.Int(0),
						RoleDescription: pulumi.String("string"),
						RoleName:        pulumi.String("string"),
						SubGroups: akamai.IamApiClientGroupAccessGroupSubGroupArray{
							iamApiClientGroupAccessGroupSubGroup,
						},
					},
				},
			},
		},
	},
	Credential: &akamai.IamApiClientCredentialArgs{
		Actions: &akamai.IamApiClientCredentialActionsArgs{
			Activate:        pulumi.Bool(false),
			Deactivate:      pulumi.Bool(false),
			Delete:          pulumi.Bool(false),
			EditDescription: pulumi.Bool(false),
			EditExpiration:  pulumi.Bool(false),
		},
		ClientSecret: pulumi.String("string"),
		ClientToken:  pulumi.String("string"),
		CreatedOn:    pulumi.String("string"),
		CredentialId: pulumi.Int(0),
		Description:  pulumi.String("string"),
		ExpiresOn:    pulumi.String("string"),
		Status:       pulumi.String("string"),
	},
	ClientName:              pulumi.String("string"),
	CanAutoCreateCredential: pulumi.Bool(false),
	ClientDescription:       pulumi.String("string"),
	AllowAccountSwitch:      pulumi.Bool(false),
	IpAcl: &akamai.IamApiClientIpAclArgs{
		Enable: pulumi.Bool(false),
		Cidrs: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Lock: pulumi.Bool(false),
	NotificationEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
	PurgeOptions: &akamai.IamApiClientPurgeOptionsArgs{
		CanPurgeByCacheTag: pulumi.Bool(false),
		CanPurgeByCpCode:   pulumi.Bool(false),
		CpCodeAccess: &akamai.IamApiClientPurgeOptionsCpCodeAccessArgs{
			AllCurrentAndNewCpCodes: pulumi.Bool(false),
			CpCodes: pulumi.IntArray{
				pulumi.Int(0),
			},
		},
	},
})

    var iamApiClientResource = new IamApiClient("iamApiClientResource", IamApiClientArgs.builder()
    .clientType("string")
    .apiAccess(IamApiClientApiAccessArgs.builder()
        .allAccessibleApis(false)
        .apis(IamApiClientApiAccessApiArgs.builder()
            .accessLevel("string")
            .apiId(0)
            .apiName("string")
            .description("string")
            .documentationUrl("string")
            .endpoint("string")
            .build())
        .build())
    .authorizedUsers("string")
    .groupAccess(IamApiClientGroupAccessArgs.builder()
        .cloneAuthorizedUserGroups(false)
        .groups(IamApiClientGroupAccessGroupArgs.builder()
            .groupId(0)
            .roleId(0)
            .groupName("string")
            .isBlocked(false)
            .parentGroupId(0)
            .roleDescription("string")
            .roleName("string")
            .subGroups(IamApiClientGroupAccessGroupSubGroupArgs.builder()
                .groupId(0)
                .roleId(0)
                .groupName("string")
                .isBlocked(false)
                .parentGroupId(0)
                .roleDescription("string")
                .roleName("string")
                .subGroups(iamApiClientGroupAccessGroupSubGroup)
                .build())
            .build())
        .build())
    .credential(IamApiClientCredentialArgs.builder()
        .actions(IamApiClientCredentialActionsArgs.builder()
            .activate(false)
            .deactivate(false)
            .delete(false)
            .editDescription(false)
            .editExpiration(false)
            .build())
        .clientSecret("string")
        .clientToken("string")
        .createdOn("string")
        .credentialId(0)
        .description("string")
        .expiresOn("string")
        .status("string")
        .build())
    .clientName("string")
    .canAutoCreateCredential(false)
    .clientDescription("string")
    .allowAccountSwitch(false)
    .ipAcl(IamApiClientIpAclArgs.builder()
        .enable(false)
        .cidrs("string")
        .build())
    .lock(false)
    .notificationEmails("string")
    .purgeOptions(IamApiClientPurgeOptionsArgs.builder()
        .canPurgeByCacheTag(false)
        .canPurgeByCpCode(false)
        .cpCodeAccess(IamApiClientPurgeOptionsCpCodeAccessArgs.builder()
            .allCurrentAndNewCpCodes(false)
            .cpCodes(0)
            .build())
        .build())
    .build());

    iam_api_client_resource = akamai.IamApiClient("iamApiClientResource",
    client_type="string",
    api_access={
        "all_accessible_apis": False,
        "apis": [{
            "access_level": "string",
            "api_id": 0,
            "api_name": "string",
            "description": "string",
            "documentation_url": "string",
            "endpoint": "string",
        }],
    },
    authorized_users=["string"],
    group_access={
        "clone_authorized_user_groups": False,
        "groups": [{
            "group_id": 0,
            "role_id": 0,
            "group_name": "string",
            "is_blocked": False,
            "parent_group_id": 0,
            "role_description": "string",
            "role_name": "string",
            "sub_groups": [{
                "group_id": 0,
                "role_id": 0,
                "group_name": "string",
                "is_blocked": False,
                "parent_group_id": 0,
                "role_description": "string",
                "role_name": "string",
                "sub_groups": [iam_api_client_group_access_group_sub_group],
            }],
        }],
    },
    credential={
        "actions": {
            "activate": False,
            "deactivate": False,
            "delete": False,
            "edit_description": False,
            "edit_expiration": False,
        },
        "client_secret": "string",
        "client_token": "string",
        "created_on": "string",
        "credential_id": 0,
        "description": "string",
        "expires_on": "string",
        "status": "string",
    },
    client_name="string",
    can_auto_create_credential=False,
    client_description="string",
    allow_account_switch=False,
    ip_acl={
        "enable": False,
        "cidrs": ["string"],
    },
    lock=False,
    notification_emails=["string"],
    purge_options={
        "can_purge_by_cache_tag": False,
        "can_purge_by_cp_code": False,
        "cp_code_access": {
            "all_current_and_new_cp_codes": False,
            "cp_codes": [0],
        },
    })

    const iamApiClientResource = new akamai.IamApiClient("iamApiClientResource", {
    clientType: "string",
    apiAccess: {
        allAccessibleApis: false,
        apis: [{
            accessLevel: "string",
            apiId: 0,
            apiName: "string",
            description: "string",
            documentationUrl: "string",
            endpoint: "string",
        }],
    },
    authorizedUsers: ["string"],
    groupAccess: {
        cloneAuthorizedUserGroups: false,
        groups: [{
            groupId: 0,
            roleId: 0,
            groupName: "string",
            isBlocked: false,
            parentGroupId: 0,
            roleDescription: "string",
            roleName: "string",
            subGroups: [{
                groupId: 0,
                roleId: 0,
                groupName: "string",
                isBlocked: false,
                parentGroupId: 0,
                roleDescription: "string",
                roleName: "string",
                subGroups: [iamApiClientGroupAccessGroupSubGroup],
            }],
        }],
    },
    credential: {
        actions: {
            activate: false,
            deactivate: false,
            "delete": false,
            editDescription: false,
            editExpiration: false,
        },
        clientSecret: "string",
        clientToken: "string",
        createdOn: "string",
        credentialId: 0,
        description: "string",
        expiresOn: "string",
        status: "string",
    },
    clientName: "string",
    canAutoCreateCredential: false,
    clientDescription: "string",
    allowAccountSwitch: false,
    ipAcl: {
        enable: false,
        cidrs: ["string"],
    },
    lock: false,
    notificationEmails: ["string"],
    purgeOptions: {
        canPurgeByCacheTag: false,
        canPurgeByCpCode: false,
        cpCodeAccess: {
            allCurrentAndNewCpCodes: false,
            cpCodes: [0],
        },
    },
});

    type: akamai:IamApiClient
properties:
    allowAccountSwitch: false
    apiAccess:
        allAccessibleApis: false
        apis:
            - accessLevel: string
              apiId: 0
              apiName: string
              description: string
              documentationUrl: string
              endpoint: string
    authorizedUsers:
        - string
    canAutoCreateCredential: false
    clientDescription: string
    clientName: string
    clientType: string
    credential:
        actions:
            activate: false
            deactivate: false
            delete: false
            editDescription: false
            editExpiration: false
        clientSecret: string
        clientToken: string
        createdOn: string
        credentialId: 0
        description: string
        expiresOn: string
        status: string
    groupAccess:
        cloneAuthorizedUserGroups: false
        groups:
            - groupId: 0
              groupName: string
              isBlocked: false
              parentGroupId: 0
              roleDescription: string
              roleId: 0
              roleName: string
              subGroups:
                - groupId: 0
                  groupName: string
                  isBlocked: false
                  parentGroupId: 0
                  roleDescription: string
                  roleId: 0
                  roleName: string
                  subGroups:
                    - ${iamApiClientGroupAccessGroupSubGroup}
    ipAcl:
        cidrs:
            - string
        enable: false
    lock: false
    notificationEmails:
        - string
    purgeOptions:
        canPurgeByCacheTag: false
        canPurgeByCpCode: false
        cpCodeAccess:
            allCurrentAndNewCpCodes: false
            cpCodes:
                - 0

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

    ApiAccess IamApiClientApiAccess
    The APIs the API client can access.
    AuthorizedUsers List<string>
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    ClientName string
    A human-readable name for the API client.
    ClientType string
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    Credential IamApiClientCredential
    GroupAccess IamApiClientGroupAccess
    Specifies the API client's group access.
    AllowAccountSwitch bool
    Enables the API client to manage more than one account.
    CanAutoCreateCredential bool
    Whether the API client can create a credential for a new API client. The default is false.
    ClientDescription string
    A human-readable description of the API client.
    IpAcl IamApiClientIpAcl
    Specifies the API client's IP list restriction.
    Lock bool
    Whether to lock or unlock the API client.
    NotificationEmails List<string>
    Email addresses to notify users when credentials expire.
    PurgeOptions IamApiClientPurgeOptions
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    ApiAccess IamApiClientApiAccessArgs
    The APIs the API client can access.
    AuthorizedUsers []string
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    ClientName string
    A human-readable name for the API client.
    ClientType string
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    Credential IamApiClientCredentialArgs
    GroupAccess IamApiClientGroupAccessArgs
    Specifies the API client's group access.
    AllowAccountSwitch bool
    Enables the API client to manage more than one account.
    CanAutoCreateCredential bool
    Whether the API client can create a credential for a new API client. The default is false.
    ClientDescription string
    A human-readable description of the API client.
    IpAcl IamApiClientIpAclArgs
    Specifies the API client's IP list restriction.
    Lock bool
    Whether to lock or unlock the API client.
    NotificationEmails []string
    Email addresses to notify users when credentials expire.
    PurgeOptions IamApiClientPurgeOptionsArgs
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    apiAccess IamApiClientApiAccess
    The APIs the API client can access.
    authorizedUsers List<String>
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    clientName String
    A human-readable name for the API client.
    clientType String
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    credential IamApiClientCredential
    groupAccess IamApiClientGroupAccess
    Specifies the API client's group access.
    allowAccountSwitch Boolean
    Enables the API client to manage more than one account.
    canAutoCreateCredential Boolean
    Whether the API client can create a credential for a new API client. The default is false.
    clientDescription String
    A human-readable description of the API client.
    ipAcl IamApiClientIpAcl
    Specifies the API client's IP list restriction.
    lock Boolean
    Whether to lock or unlock the API client.
    notificationEmails List<String>
    Email addresses to notify users when credentials expire.
    purgeOptions IamApiClientPurgeOptions
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    apiAccess IamApiClientApiAccess
    The APIs the API client can access.
    authorizedUsers string[]
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    clientName string
    A human-readable name for the API client.
    clientType string
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    credential IamApiClientCredential
    groupAccess IamApiClientGroupAccess
    Specifies the API client's group access.
    allowAccountSwitch boolean
    Enables the API client to manage more than one account.
    canAutoCreateCredential boolean
    Whether the API client can create a credential for a new API client. The default is false.
    clientDescription string
    A human-readable description of the API client.
    ipAcl IamApiClientIpAcl
    Specifies the API client's IP list restriction.
    lock boolean
    Whether to lock or unlock the API client.
    notificationEmails string[]
    Email addresses to notify users when credentials expire.
    purgeOptions IamApiClientPurgeOptions
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    api_access IamApiClientApiAccessArgs
    The APIs the API client can access.
    authorized_users Sequence[str]
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    client_name str
    A human-readable name for the API client.
    client_type str
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    credential IamApiClientCredentialArgs
    group_access IamApiClientGroupAccessArgs
    Specifies the API client's group access.
    allow_account_switch bool
    Enables the API client to manage more than one account.
    can_auto_create_credential bool
    Whether the API client can create a credential for a new API client. The default is false.
    client_description str
    A human-readable description of the API client.
    ip_acl IamApiClientIpAclArgs
    Specifies the API client's IP list restriction.
    lock bool
    Whether to lock or unlock the API client.
    notification_emails Sequence[str]
    Email addresses to notify users when credentials expire.
    purge_options IamApiClientPurgeOptionsArgs
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    apiAccess Property Map
    The APIs the API client can access.
    authorizedUsers List<String>
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    clientName String
    A human-readable name for the API client.
    clientType String
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    credential Property Map
    groupAccess Property Map
    Specifies the API client's group access.
    allowAccountSwitch Boolean
    Enables the API client to manage more than one account.
    canAutoCreateCredential Boolean
    Whether the API client can create a credential for a new API client. The default is false.
    clientDescription String
    A human-readable description of the API client.
    ipAcl Property Map
    Specifies the API client's IP list restriction.
    lock Boolean
    Whether to lock or unlock the API client.
    notificationEmails List<String>
    Email addresses to notify users when credentials expire.
    purgeOptions Property Map
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.

    Outputs

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

    AccessToken string
    The part of the client secret that identifies your API client and lets you access applications and resources.
    Actions IamApiClientActions
    Specifies activities available for the API client.
    ActiveCredentialCount int
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    BaseUrl string
    The base URL for the service.
    ClientId string
    A unique identifier for the API client.
    CreatedBy string
    The user who created the API client.
    CreatedDate string
    The ISO 8601 timestamp indicating when the API client was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccessToken string
    The part of the client secret that identifies your API client and lets you access applications and resources.
    Actions IamApiClientActions
    Specifies activities available for the API client.
    ActiveCredentialCount int
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    BaseUrl string
    The base URL for the service.
    ClientId string
    A unique identifier for the API client.
    CreatedBy string
    The user who created the API client.
    CreatedDate string
    The ISO 8601 timestamp indicating when the API client was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    accessToken String
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions IamApiClientActions
    Specifies activities available for the API client.
    activeCredentialCount Integer
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    baseUrl String
    The base URL for the service.
    clientId String
    A unique identifier for the API client.
    createdBy String
    The user who created the API client.
    createdDate String
    The ISO 8601 timestamp indicating when the API client was created.
    id String
    The provider-assigned unique ID for this managed resource.
    accessToken string
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions IamApiClientActions
    Specifies activities available for the API client.
    activeCredentialCount number
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    baseUrl string
    The base URL for the service.
    clientId string
    A unique identifier for the API client.
    createdBy string
    The user who created the API client.
    createdDate string
    The ISO 8601 timestamp indicating when the API client was created.
    id string
    The provider-assigned unique ID for this managed resource.
    access_token str
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions IamApiClientActions
    Specifies activities available for the API client.
    active_credential_count int
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    base_url str
    The base URL for the service.
    client_id str
    A unique identifier for the API client.
    created_by str
    The user who created the API client.
    created_date str
    The ISO 8601 timestamp indicating when the API client was created.
    id str
    The provider-assigned unique ID for this managed resource.
    accessToken String
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions Property Map
    Specifies activities available for the API client.
    activeCredentialCount Number
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    baseUrl String
    The base URL for the service.
    clientId String
    A unique identifier for the API client.
    createdBy String
    The user who created the API client.
    createdDate String
    The ISO 8601 timestamp indicating when the API client was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IamApiClient Resource

    Get an existing IamApiClient 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?: IamApiClientState, opts?: CustomResourceOptions): IamApiClient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_token: Optional[str] = None,
        actions: Optional[IamApiClientActionsArgs] = None,
        active_credential_count: Optional[int] = None,
        allow_account_switch: Optional[bool] = None,
        api_access: Optional[IamApiClientApiAccessArgs] = None,
        authorized_users: Optional[Sequence[str]] = None,
        base_url: Optional[str] = None,
        can_auto_create_credential: Optional[bool] = None,
        client_description: Optional[str] = None,
        client_id: Optional[str] = None,
        client_name: Optional[str] = None,
        client_type: Optional[str] = None,
        created_by: Optional[str] = None,
        created_date: Optional[str] = None,
        credential: Optional[IamApiClientCredentialArgs] = None,
        group_access: Optional[IamApiClientGroupAccessArgs] = None,
        ip_acl: Optional[IamApiClientIpAclArgs] = None,
        lock: Optional[bool] = None,
        notification_emails: Optional[Sequence[str]] = None,
        purge_options: Optional[IamApiClientPurgeOptionsArgs] = None) -> IamApiClient
    func GetIamApiClient(ctx *Context, name string, id IDInput, state *IamApiClientState, opts ...ResourceOption) (*IamApiClient, error)
    public static IamApiClient Get(string name, Input<string> id, IamApiClientState? state, CustomResourceOptions? opts = null)
    public static IamApiClient get(String name, Output<String> id, IamApiClientState state, CustomResourceOptions options)
    resources:  _:    type: akamai:IamApiClient    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:
    AccessToken string
    The part of the client secret that identifies your API client and lets you access applications and resources.
    Actions IamApiClientActions
    Specifies activities available for the API client.
    ActiveCredentialCount int
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    AllowAccountSwitch bool
    Enables the API client to manage more than one account.
    ApiAccess IamApiClientApiAccess
    The APIs the API client can access.
    AuthorizedUsers List<string>
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    BaseUrl string
    The base URL for the service.
    CanAutoCreateCredential bool
    Whether the API client can create a credential for a new API client. The default is false.
    ClientDescription string
    A human-readable description of the API client.
    ClientId string
    A unique identifier for the API client.
    ClientName string
    A human-readable name for the API client.
    ClientType string
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    CreatedBy string
    The user who created the API client.
    CreatedDate string
    The ISO 8601 timestamp indicating when the API client was created.
    Credential IamApiClientCredential
    GroupAccess IamApiClientGroupAccess
    Specifies the API client's group access.
    IpAcl IamApiClientIpAcl
    Specifies the API client's IP list restriction.
    Lock bool
    Whether to lock or unlock the API client.
    NotificationEmails List<string>
    Email addresses to notify users when credentials expire.
    PurgeOptions IamApiClientPurgeOptions
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    AccessToken string
    The part of the client secret that identifies your API client and lets you access applications and resources.
    Actions IamApiClientActionsArgs
    Specifies activities available for the API client.
    ActiveCredentialCount int
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    AllowAccountSwitch bool
    Enables the API client to manage more than one account.
    ApiAccess IamApiClientApiAccessArgs
    The APIs the API client can access.
    AuthorizedUsers []string
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    BaseUrl string
    The base URL for the service.
    CanAutoCreateCredential bool
    Whether the API client can create a credential for a new API client. The default is false.
    ClientDescription string
    A human-readable description of the API client.
    ClientId string
    A unique identifier for the API client.
    ClientName string
    A human-readable name for the API client.
    ClientType string
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    CreatedBy string
    The user who created the API client.
    CreatedDate string
    The ISO 8601 timestamp indicating when the API client was created.
    Credential IamApiClientCredentialArgs
    GroupAccess IamApiClientGroupAccessArgs
    Specifies the API client's group access.
    IpAcl IamApiClientIpAclArgs
    Specifies the API client's IP list restriction.
    Lock bool
    Whether to lock or unlock the API client.
    NotificationEmails []string
    Email addresses to notify users when credentials expire.
    PurgeOptions IamApiClientPurgeOptionsArgs
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    accessToken String
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions IamApiClientActions
    Specifies activities available for the API client.
    activeCredentialCount Integer
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    allowAccountSwitch Boolean
    Enables the API client to manage more than one account.
    apiAccess IamApiClientApiAccess
    The APIs the API client can access.
    authorizedUsers List<String>
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    baseUrl String
    The base URL for the service.
    canAutoCreateCredential Boolean
    Whether the API client can create a credential for a new API client. The default is false.
    clientDescription String
    A human-readable description of the API client.
    clientId String
    A unique identifier for the API client.
    clientName String
    A human-readable name for the API client.
    clientType String
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    createdBy String
    The user who created the API client.
    createdDate String
    The ISO 8601 timestamp indicating when the API client was created.
    credential IamApiClientCredential
    groupAccess IamApiClientGroupAccess
    Specifies the API client's group access.
    ipAcl IamApiClientIpAcl
    Specifies the API client's IP list restriction.
    lock Boolean
    Whether to lock or unlock the API client.
    notificationEmails List<String>
    Email addresses to notify users when credentials expire.
    purgeOptions IamApiClientPurgeOptions
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    accessToken string
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions IamApiClientActions
    Specifies activities available for the API client.
    activeCredentialCount number
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    allowAccountSwitch boolean
    Enables the API client to manage more than one account.
    apiAccess IamApiClientApiAccess
    The APIs the API client can access.
    authorizedUsers string[]
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    baseUrl string
    The base URL for the service.
    canAutoCreateCredential boolean
    Whether the API client can create a credential for a new API client. The default is false.
    clientDescription string
    A human-readable description of the API client.
    clientId string
    A unique identifier for the API client.
    clientName string
    A human-readable name for the API client.
    clientType string
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    createdBy string
    The user who created the API client.
    createdDate string
    The ISO 8601 timestamp indicating when the API client was created.
    credential IamApiClientCredential
    groupAccess IamApiClientGroupAccess
    Specifies the API client's group access.
    ipAcl IamApiClientIpAcl
    Specifies the API client's IP list restriction.
    lock boolean
    Whether to lock or unlock the API client.
    notificationEmails string[]
    Email addresses to notify users when credentials expire.
    purgeOptions IamApiClientPurgeOptions
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    access_token str
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions IamApiClientActionsArgs
    Specifies activities available for the API client.
    active_credential_count int
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    allow_account_switch bool
    Enables the API client to manage more than one account.
    api_access IamApiClientApiAccessArgs
    The APIs the API client can access.
    authorized_users Sequence[str]
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    base_url str
    The base URL for the service.
    can_auto_create_credential bool
    Whether the API client can create a credential for a new API client. The default is false.
    client_description str
    A human-readable description of the API client.
    client_id str
    A unique identifier for the API client.
    client_name str
    A human-readable name for the API client.
    client_type str
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    created_by str
    The user who created the API client.
    created_date str
    The ISO 8601 timestamp indicating when the API client was created.
    credential IamApiClientCredentialArgs
    group_access IamApiClientGroupAccessArgs
    Specifies the API client's group access.
    ip_acl IamApiClientIpAclArgs
    Specifies the API client's IP list restriction.
    lock bool
    Whether to lock or unlock the API client.
    notification_emails Sequence[str]
    Email addresses to notify users when credentials expire.
    purge_options IamApiClientPurgeOptionsArgs
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.
    accessToken String
    The part of the client secret that identifies your API client and lets you access applications and resources.
    actions Property Map
    Specifies activities available for the API client.
    activeCredentialCount Number
    The number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.
    allowAccountSwitch Boolean
    Enables the API client to manage more than one account.
    apiAccess Property Map
    The APIs the API client can access.
    authorizedUsers List<String>
    The API client's valid users. When the 'client_type' is either 'CLIENT' or 'USER_CLIENT', you need to specify a single username in an array.
    baseUrl String
    The base URL for the service.
    canAutoCreateCredential Boolean
    Whether the API client can create a credential for a new API client. The default is false.
    clientDescription String
    A human-readable description of the API client.
    clientId String
    A unique identifier for the API client.
    clientName String
    A human-readable name for the API client.
    clientType String
    Specifies the API client's ownership and credential management. 'CLIENT' indicates the creator owns and manages the credentials. 'USER_CLIENT' indicates another user owns the client and manages the credentials.
    createdBy String
    The user who created the API client.
    createdDate String
    The ISO 8601 timestamp indicating when the API client was created.
    credential Property Map
    groupAccess Property Map
    Specifies the API client's group access.
    ipAcl Property Map
    Specifies the API client's IP list restriction.
    lock Boolean
    Whether to lock or unlock the API client.
    notificationEmails List<String>
    Email addresses to notify users when credentials expire.
    purgeOptions Property Map
    Configures the API client to access the Fast Purge API. Provide it only if the apis attribute includes an api_name of CCU API.

    Supporting Types

    IamApiClientActions, IamApiClientActionsArgs

    DeactivateAll bool
    Whether you can deactivate the API client's credentials.
    Delete bool
    Whether you can remove the API client.
    Edit bool
    Whether you can update the API client.
    EditApis bool
    Whether you can update the apis the API client can access, same as edit_auth.
    EditAuth bool
    Whether you can update the apis the API client can access, same as edit_apis.
    EditGroups bool
    Whether you can update the groups the API client can access.
    EditIpAcl bool
    Whether you can update the 'ip acl' the API client can access.
    EditSwitchAccount bool
    Whether you can update the API client's option to manage many accounts.
    Lock bool
    Whether you can lock the API client.
    Transfer bool
    Whether you can transfer the API client to a new owner.
    Unlock bool
    Whether you can unlock the API client.
    DeactivateAll bool
    Whether you can deactivate the API client's credentials.
    Delete bool
    Whether you can remove the API client.
    Edit bool
    Whether you can update the API client.
    EditApis bool
    Whether you can update the apis the API client can access, same as edit_auth.
    EditAuth bool
    Whether you can update the apis the API client can access, same as edit_apis.
    EditGroups bool
    Whether you can update the groups the API client can access.
    EditIpAcl bool
    Whether you can update the 'ip acl' the API client can access.
    EditSwitchAccount bool
    Whether you can update the API client's option to manage many accounts.
    Lock bool
    Whether you can lock the API client.
    Transfer bool
    Whether you can transfer the API client to a new owner.
    Unlock bool
    Whether you can unlock the API client.
    deactivateAll Boolean
    Whether you can deactivate the API client's credentials.
    delete Boolean
    Whether you can remove the API client.
    edit Boolean
    Whether you can update the API client.
    editApis Boolean
    Whether you can update the apis the API client can access, same as edit_auth.
    editAuth Boolean
    Whether you can update the apis the API client can access, same as edit_apis.
    editGroups Boolean
    Whether you can update the groups the API client can access.
    editIpAcl Boolean
    Whether you can update the 'ip acl' the API client can access.
    editSwitchAccount Boolean
    Whether you can update the API client's option to manage many accounts.
    lock Boolean
    Whether you can lock the API client.
    transfer Boolean
    Whether you can transfer the API client to a new owner.
    unlock Boolean
    Whether you can unlock the API client.
    deactivateAll boolean
    Whether you can deactivate the API client's credentials.
    delete boolean
    Whether you can remove the API client.
    edit boolean
    Whether you can update the API client.
    editApis boolean
    Whether you can update the apis the API client can access, same as edit_auth.
    editAuth boolean
    Whether you can update the apis the API client can access, same as edit_apis.
    editGroups boolean
    Whether you can update the groups the API client can access.
    editIpAcl boolean
    Whether you can update the 'ip acl' the API client can access.
    editSwitchAccount boolean
    Whether you can update the API client's option to manage many accounts.
    lock boolean
    Whether you can lock the API client.
    transfer boolean
    Whether you can transfer the API client to a new owner.
    unlock boolean
    Whether you can unlock the API client.
    deactivate_all bool
    Whether you can deactivate the API client's credentials.
    delete bool
    Whether you can remove the API client.
    edit bool
    Whether you can update the API client.
    edit_apis bool
    Whether you can update the apis the API client can access, same as edit_auth.
    edit_auth bool
    Whether you can update the apis the API client can access, same as edit_apis.
    edit_groups bool
    Whether you can update the groups the API client can access.
    edit_ip_acl bool
    Whether you can update the 'ip acl' the API client can access.
    edit_switch_account bool
    Whether you can update the API client's option to manage many accounts.
    lock bool
    Whether you can lock the API client.
    transfer bool
    Whether you can transfer the API client to a new owner.
    unlock bool
    Whether you can unlock the API client.
    deactivateAll Boolean
    Whether you can deactivate the API client's credentials.
    delete Boolean
    Whether you can remove the API client.
    edit Boolean
    Whether you can update the API client.
    editApis Boolean
    Whether you can update the apis the API client can access, same as edit_auth.
    editAuth Boolean
    Whether you can update the apis the API client can access, same as edit_apis.
    editGroups Boolean
    Whether you can update the groups the API client can access.
    editIpAcl Boolean
    Whether you can update the 'ip acl' the API client can access.
    editSwitchAccount Boolean
    Whether you can update the API client's option to manage many accounts.
    lock Boolean
    Whether you can lock the API client.
    transfer Boolean
    Whether you can transfer the API client to a new owner.
    unlock Boolean
    Whether you can unlock the API client.

    IamApiClientApiAccess, IamApiClientApiAccessArgs

    AllAccessibleApis bool
    Enables the API client to access a full set of available APIs.
    Apis List<IamApiClientApiAccessApi>
    The set of APIs the API client can access when all_accessible_apis is false.
    AllAccessibleApis bool
    Enables the API client to access a full set of available APIs.
    Apis []IamApiClientApiAccessApi
    The set of APIs the API client can access when all_accessible_apis is false.
    allAccessibleApis Boolean
    Enables the API client to access a full set of available APIs.
    apis List<IamApiClientApiAccessApi>
    The set of APIs the API client can access when all_accessible_apis is false.
    allAccessibleApis boolean
    Enables the API client to access a full set of available APIs.
    apis IamApiClientApiAccessApi[]
    The set of APIs the API client can access when all_accessible_apis is false.
    all_accessible_apis bool
    Enables the API client to access a full set of available APIs.
    apis Sequence[IamApiClientApiAccessApi]
    The set of APIs the API client can access when all_accessible_apis is false.
    allAccessibleApis Boolean
    Enables the API client to access a full set of available APIs.
    apis List<Property Map>
    The set of APIs the API client can access when all_accessible_apis is false.

    IamApiClientApiAccessApi, IamApiClientApiAccessApiArgs

    AccessLevel string
    The API client's access level on an API basis, either 'READ-ONLY', 'READ-WRITE', 'CREDENTIAL-READ-ONLY', or 'CREDENTIAL-READ-WRITE'.
    ApiId int
    A unique identifier of the API.
    ApiName string
    A human-readable name for the API.
    Description string
    A human-readable description for the API.
    DocumentationUrl string
    A link to more information about the API.
    Endpoint string
    Specifies where the API can access resources.
    AccessLevel string
    The API client's access level on an API basis, either 'READ-ONLY', 'READ-WRITE', 'CREDENTIAL-READ-ONLY', or 'CREDENTIAL-READ-WRITE'.
    ApiId int
    A unique identifier of the API.
    ApiName string
    A human-readable name for the API.
    Description string
    A human-readable description for the API.
    DocumentationUrl string
    A link to more information about the API.
    Endpoint string
    Specifies where the API can access resources.
    accessLevel String
    The API client's access level on an API basis, either 'READ-ONLY', 'READ-WRITE', 'CREDENTIAL-READ-ONLY', or 'CREDENTIAL-READ-WRITE'.
    apiId Integer
    A unique identifier of the API.
    apiName String
    A human-readable name for the API.
    description String
    A human-readable description for the API.
    documentationUrl String
    A link to more information about the API.
    endpoint String
    Specifies where the API can access resources.
    accessLevel string
    The API client's access level on an API basis, either 'READ-ONLY', 'READ-WRITE', 'CREDENTIAL-READ-ONLY', or 'CREDENTIAL-READ-WRITE'.
    apiId number
    A unique identifier of the API.
    apiName string
    A human-readable name for the API.
    description string
    A human-readable description for the API.
    documentationUrl string
    A link to more information about the API.
    endpoint string
    Specifies where the API can access resources.
    access_level str
    The API client's access level on an API basis, either 'READ-ONLY', 'READ-WRITE', 'CREDENTIAL-READ-ONLY', or 'CREDENTIAL-READ-WRITE'.
    api_id int
    A unique identifier of the API.
    api_name str
    A human-readable name for the API.
    description str
    A human-readable description for the API.
    documentation_url str
    A link to more information about the API.
    endpoint str
    Specifies where the API can access resources.
    accessLevel String
    The API client's access level on an API basis, either 'READ-ONLY', 'READ-WRITE', 'CREDENTIAL-READ-ONLY', or 'CREDENTIAL-READ-WRITE'.
    apiId Number
    A unique identifier of the API.
    apiName String
    A human-readable name for the API.
    description String
    A human-readable description for the API.
    documentationUrl String
    A link to more information about the API.
    endpoint String
    Specifies where the API can access resources.

    IamApiClientCredential, IamApiClientCredentialArgs

    Actions IamApiClientCredentialActions
    Actions available on the API client's credentials.
    ClientSecret string
    The client secret.
    ClientToken string
    The part of the credential that identifies the API client.
    CreatedOn string
    The ISO 8601 timestamp indicating when the credential was created.
    CredentialId int
    A unique identifier of the credential.
    Description string
    A human-readable description for the credential.
    ExpiresOn string
    The ISO 8601 timestamp indicating when the credential expires. The default expiration date is two years from the creation date.
    Status string
    Whether a credential is 'ACTIVE', 'INACTIVE', or 'DELETED'. Can be updated to 'ACTIVE' or 'INACTIVE' only.
    Actions IamApiClientCredentialActions
    Actions available on the API client's credentials.
    ClientSecret string
    The client secret.
    ClientToken string
    The part of the credential that identifies the API client.
    CreatedOn string
    The ISO 8601 timestamp indicating when the credential was created.
    CredentialId int
    A unique identifier of the credential.
    Description string
    A human-readable description for the credential.
    ExpiresOn string
    The ISO 8601 timestamp indicating when the credential expires. The default expiration date is two years from the creation date.
    Status string
    Whether a credential is 'ACTIVE', 'INACTIVE', or 'DELETED'. Can be updated to 'ACTIVE' or 'INACTIVE' only.
    actions IamApiClientCredentialActions
    Actions available on the API client's credentials.
    clientSecret String
    The client secret.
    clientToken String
    The part of the credential that identifies the API client.
    createdOn String
    The ISO 8601 timestamp indicating when the credential was created.
    credentialId Integer
    A unique identifier of the credential.
    description String
    A human-readable description for the credential.
    expiresOn String
    The ISO 8601 timestamp indicating when the credential expires. The default expiration date is two years from the creation date.
    status String
    Whether a credential is 'ACTIVE', 'INACTIVE', or 'DELETED'. Can be updated to 'ACTIVE' or 'INACTIVE' only.
    actions IamApiClientCredentialActions
    Actions available on the API client's credentials.
    clientSecret string
    The client secret.
    clientToken string
    The part of the credential that identifies the API client.
    createdOn string
    The ISO 8601 timestamp indicating when the credential was created.
    credentialId number
    A unique identifier of the credential.
    description string
    A human-readable description for the credential.
    expiresOn string
    The ISO 8601 timestamp indicating when the credential expires. The default expiration date is two years from the creation date.
    status string
    Whether a credential is 'ACTIVE', 'INACTIVE', or 'DELETED'. Can be updated to 'ACTIVE' or 'INACTIVE' only.
    actions IamApiClientCredentialActions
    Actions available on the API client's credentials.
    client_secret str
    The client secret.
    client_token str
    The part of the credential that identifies the API client.
    created_on str
    The ISO 8601 timestamp indicating when the credential was created.
    credential_id int
    A unique identifier of the credential.
    description str
    A human-readable description for the credential.
    expires_on str
    The ISO 8601 timestamp indicating when the credential expires. The default expiration date is two years from the creation date.
    status str
    Whether a credential is 'ACTIVE', 'INACTIVE', or 'DELETED'. Can be updated to 'ACTIVE' or 'INACTIVE' only.
    actions Property Map
    Actions available on the API client's credentials.
    clientSecret String
    The client secret.
    clientToken String
    The part of the credential that identifies the API client.
    createdOn String
    The ISO 8601 timestamp indicating when the credential was created.
    credentialId Number
    A unique identifier of the credential.
    description String
    A human-readable description for the credential.
    expiresOn String
    The ISO 8601 timestamp indicating when the credential expires. The default expiration date is two years from the creation date.
    status String
    Whether a credential is 'ACTIVE', 'INACTIVE', or 'DELETED'. Can be updated to 'ACTIVE' or 'INACTIVE' only.

    IamApiClientCredentialActions, IamApiClientCredentialActionsArgs

    Activate bool
    Whether you can activate the credential.
    Deactivate bool
    Whether you can deactivate the credential.
    Delete bool
    Whether you can remove the credential.
    EditDescription bool
    Whether you can modify the credential's description.
    EditExpiration bool
    Whether you can modify the credential's expiration date.
    Activate bool
    Whether you can activate the credential.
    Deactivate bool
    Whether you can deactivate the credential.
    Delete bool
    Whether you can remove the credential.
    EditDescription bool
    Whether you can modify the credential's description.
    EditExpiration bool
    Whether you can modify the credential's expiration date.
    activate Boolean
    Whether you can activate the credential.
    deactivate Boolean
    Whether you can deactivate the credential.
    delete Boolean
    Whether you can remove the credential.
    editDescription Boolean
    Whether you can modify the credential's description.
    editExpiration Boolean
    Whether you can modify the credential's expiration date.
    activate boolean
    Whether you can activate the credential.
    deactivate boolean
    Whether you can deactivate the credential.
    delete boolean
    Whether you can remove the credential.
    editDescription boolean
    Whether you can modify the credential's description.
    editExpiration boolean
    Whether you can modify the credential's expiration date.
    activate bool
    Whether you can activate the credential.
    deactivate bool
    Whether you can deactivate the credential.
    delete bool
    Whether you can remove the credential.
    edit_description bool
    Whether you can modify the credential's description.
    edit_expiration bool
    Whether you can modify the credential's expiration date.
    activate Boolean
    Whether you can activate the credential.
    deactivate Boolean
    Whether you can deactivate the credential.
    delete Boolean
    Whether you can remove the credential.
    editDescription Boolean
    Whether you can modify the credential's description.
    editExpiration Boolean
    Whether you can modify the credential's expiration date.

    IamApiClientGroupAccess, IamApiClientGroupAccessArgs

    CloneAuthorizedUserGroups bool
    Sets the API client's group access the same as the authorized user.
    Groups List<IamApiClientGroupAccessGroup>
    Groups the API client can access.
    CloneAuthorizedUserGroups bool
    Sets the API client's group access the same as the authorized user.
    Groups []IamApiClientGroupAccessGroup
    Groups the API client can access.
    cloneAuthorizedUserGroups Boolean
    Sets the API client's group access the same as the authorized user.
    groups List<IamApiClientGroupAccessGroup>
    Groups the API client can access.
    cloneAuthorizedUserGroups boolean
    Sets the API client's group access the same as the authorized user.
    groups IamApiClientGroupAccessGroup[]
    Groups the API client can access.
    clone_authorized_user_groups bool
    Sets the API client's group access the same as the authorized user.
    groups Sequence[IamApiClientGroupAccessGroup]
    Groups the API client can access.
    cloneAuthorizedUserGroups Boolean
    Sets the API client's group access the same as the authorized user.
    groups List<Property Map>
    Groups the API client can access.

    IamApiClientGroupAccessGroup, IamApiClientGroupAccessGroupArgs

    GroupId int
    A unique identifier for the group.
    RoleId int
    A unique identifier for the role.
    GroupName string
    A human-readable name for the group.
    IsBlocked bool
    Blocks the API client access to the group's child groups.
    ParentGroupId int
    A unique identifier for the parent group within the group tree.
    RoleDescription string
    A human-readable description for the role to convey its use.
    RoleName string
    A human-readable name for the role.
    SubGroups List<IamApiClientGroupAccessGroupSubGroup>
    Groups the API client can access.
    GroupId int
    A unique identifier for the group.
    RoleId int
    A unique identifier for the role.
    GroupName string
    A human-readable name for the group.
    IsBlocked bool
    Blocks the API client access to the group's child groups.
    ParentGroupId int
    A unique identifier for the parent group within the group tree.
    RoleDescription string
    A human-readable description for the role to convey its use.
    RoleName string
    A human-readable name for the role.
    SubGroups []IamApiClientGroupAccessGroupSubGroup
    Groups the API client can access.
    groupId Integer
    A unique identifier for the group.
    roleId Integer
    A unique identifier for the role.
    groupName String
    A human-readable name for the group.
    isBlocked Boolean
    Blocks the API client access to the group's child groups.
    parentGroupId Integer
    A unique identifier for the parent group within the group tree.
    roleDescription String
    A human-readable description for the role to convey its use.
    roleName String
    A human-readable name for the role.
    subGroups List<IamApiClientGroupAccessGroupSubGroup>
    Groups the API client can access.
    groupId number
    A unique identifier for the group.
    roleId number
    A unique identifier for the role.
    groupName string
    A human-readable name for the group.
    isBlocked boolean
    Blocks the API client access to the group's child groups.
    parentGroupId number
    A unique identifier for the parent group within the group tree.
    roleDescription string
    A human-readable description for the role to convey its use.
    roleName string
    A human-readable name for the role.
    subGroups IamApiClientGroupAccessGroupSubGroup[]
    Groups the API client can access.
    group_id int
    A unique identifier for the group.
    role_id int
    A unique identifier for the role.
    group_name str
    A human-readable name for the group.
    is_blocked bool
    Blocks the API client access to the group's child groups.
    parent_group_id int
    A unique identifier for the parent group within the group tree.
    role_description str
    A human-readable description for the role to convey its use.
    role_name str
    A human-readable name for the role.
    sub_groups Sequence[IamApiClientGroupAccessGroupSubGroup]
    Groups the API client can access.
    groupId Number
    A unique identifier for the group.
    roleId Number
    A unique identifier for the role.
    groupName String
    A human-readable name for the group.
    isBlocked Boolean
    Blocks the API client access to the group's child groups.
    parentGroupId Number
    A unique identifier for the parent group within the group tree.
    roleDescription String
    A human-readable description for the role to convey its use.
    roleName String
    A human-readable name for the role.
    subGroups List<Property Map>
    Groups the API client can access.

    IamApiClientGroupAccessGroupSubGroup, IamApiClientGroupAccessGroupSubGroupArgs

    GroupId int
    A unique identifier for the group.
    RoleId int
    A unique identifier for the role.
    GroupName string
    A human-readable name for the group.
    IsBlocked bool
    Blocks the API client access to the group's child groups.
    ParentGroupId int
    A unique identifier for the parent group within the group tree.
    RoleDescription string
    A human-readable description for the role to convey its use.
    RoleName string
    A human-readable name for the role.
    SubGroups List<IamApiClientGroupAccessGroupSubGroup>
    Groups the API client can access.
    GroupId int
    A unique identifier for the group.
    RoleId int
    A unique identifier for the role.
    GroupName string
    A human-readable name for the group.
    IsBlocked bool
    Blocks the API client access to the group's child groups.
    ParentGroupId int
    A unique identifier for the parent group within the group tree.
    RoleDescription string
    A human-readable description for the role to convey its use.
    RoleName string
    A human-readable name for the role.
    SubGroups []IamApiClientGroupAccessGroupSubGroup
    Groups the API client can access.
    groupId Integer
    A unique identifier for the group.
    roleId Integer
    A unique identifier for the role.
    groupName String
    A human-readable name for the group.
    isBlocked Boolean
    Blocks the API client access to the group's child groups.
    parentGroupId Integer
    A unique identifier for the parent group within the group tree.
    roleDescription String
    A human-readable description for the role to convey its use.
    roleName String
    A human-readable name for the role.
    subGroups List<IamApiClientGroupAccessGroupSubGroup>
    Groups the API client can access.
    groupId number
    A unique identifier for the group.
    roleId number
    A unique identifier for the role.
    groupName string
    A human-readable name for the group.
    isBlocked boolean
    Blocks the API client access to the group's child groups.
    parentGroupId number
    A unique identifier for the parent group within the group tree.
    roleDescription string
    A human-readable description for the role to convey its use.
    roleName string
    A human-readable name for the role.
    subGroups IamApiClientGroupAccessGroupSubGroup[]
    Groups the API client can access.
    group_id int
    A unique identifier for the group.
    role_id int
    A unique identifier for the role.
    group_name str
    A human-readable name for the group.
    is_blocked bool
    Blocks the API client access to the group's child groups.
    parent_group_id int
    A unique identifier for the parent group within the group tree.
    role_description str
    A human-readable description for the role to convey its use.
    role_name str
    A human-readable name for the role.
    sub_groups Sequence[IamApiClientGroupAccessGroupSubGroup]
    Groups the API client can access.
    groupId Number
    A unique identifier for the group.
    roleId Number
    A unique identifier for the role.
    groupName String
    A human-readable name for the group.
    isBlocked Boolean
    Blocks the API client access to the group's child groups.
    parentGroupId Number
    A unique identifier for the parent group within the group tree.
    roleDescription String
    A human-readable description for the role to convey its use.
    roleName String
    A human-readable name for the role.
    subGroups List<Property Map>
    Groups the API client can access.

    IamApiClientIpAcl, IamApiClientIpAclArgs

    Enable bool
    Enables the API client to access the IP access control list (ACL).
    Cidrs List<string>
    IP addresses or CIDR blocks the API client can access.
    Enable bool
    Enables the API client to access the IP access control list (ACL).
    Cidrs []string
    IP addresses or CIDR blocks the API client can access.
    enable Boolean
    Enables the API client to access the IP access control list (ACL).
    cidrs List<String>
    IP addresses or CIDR blocks the API client can access.
    enable boolean
    Enables the API client to access the IP access control list (ACL).
    cidrs string[]
    IP addresses or CIDR blocks the API client can access.
    enable bool
    Enables the API client to access the IP access control list (ACL).
    cidrs Sequence[str]
    IP addresses or CIDR blocks the API client can access.
    enable Boolean
    Enables the API client to access the IP access control list (ACL).
    cidrs List<String>
    IP addresses or CIDR blocks the API client can access.

    IamApiClientPurgeOptions, IamApiClientPurgeOptionsArgs

    CanPurgeByCacheTag bool
    Whether the API client can purge content by cache tag.
    CanPurgeByCpCode bool
    Whether the API client can purge content by CP code.
    CpCodeAccess IamApiClientPurgeOptionsCpCodeAccess
    CP codes the API client can purge.
    CanPurgeByCacheTag bool
    Whether the API client can purge content by cache tag.
    CanPurgeByCpCode bool
    Whether the API client can purge content by CP code.
    CpCodeAccess IamApiClientPurgeOptionsCpCodeAccess
    CP codes the API client can purge.
    canPurgeByCacheTag Boolean
    Whether the API client can purge content by cache tag.
    canPurgeByCpCode Boolean
    Whether the API client can purge content by CP code.
    cpCodeAccess IamApiClientPurgeOptionsCpCodeAccess
    CP codes the API client can purge.
    canPurgeByCacheTag boolean
    Whether the API client can purge content by cache tag.
    canPurgeByCpCode boolean
    Whether the API client can purge content by CP code.
    cpCodeAccess IamApiClientPurgeOptionsCpCodeAccess
    CP codes the API client can purge.
    can_purge_by_cache_tag bool
    Whether the API client can purge content by cache tag.
    can_purge_by_cp_code bool
    Whether the API client can purge content by CP code.
    cp_code_access IamApiClientPurgeOptionsCpCodeAccess
    CP codes the API client can purge.
    canPurgeByCacheTag Boolean
    Whether the API client can purge content by cache tag.
    canPurgeByCpCode Boolean
    Whether the API client can purge content by CP code.
    cpCodeAccess Property Map
    CP codes the API client can purge.

    IamApiClientPurgeOptionsCpCodeAccess, IamApiClientPurgeOptionsCpCodeAccessArgs

    AllCurrentAndNewCpCodes bool
    Whether the API can purge content by all current and new CP codes.
    CpCodes List<int>
    CP codes the API client can purge.
    AllCurrentAndNewCpCodes bool
    Whether the API can purge content by all current and new CP codes.
    CpCodes []int
    CP codes the API client can purge.
    allCurrentAndNewCpCodes Boolean
    Whether the API can purge content by all current and new CP codes.
    cpCodes List<Integer>
    CP codes the API client can purge.
    allCurrentAndNewCpCodes boolean
    Whether the API can purge content by all current and new CP codes.
    cpCodes number[]
    CP codes the API client can purge.
    all_current_and_new_cp_codes bool
    Whether the API can purge content by all current and new CP codes.
    cp_codes Sequence[int]
    CP codes the API client can purge.
    allCurrentAndNewCpCodes Boolean
    Whether the API can purge content by all current and new CP codes.
    cpCodes List<Number>
    CP codes the API client can purge.

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v9.0.0 published on Thursday, Jun 26, 2025 by Pulumi
    pulumi/pulumi-akamai