getIamApiClients

Akamai v10.2.0, Nov 14 25

Akamai v10.2.0 published on Friday, Nov 14, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-akamai

Akamai v10.2.0 published on Friday, Nov 14, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-akamai

Using getIamApiClients

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIamApiClients(opts?: InvokeOptions): Promise<GetIamApiClientsResult>
function getIamApiClientsOutput(opts?: InvokeOptions): Output<GetIamApiClientsResult>

def get_iam_api_clients(opts: Optional[InvokeOptions] = None) -> GetIamApiClientsResult
def get_iam_api_clients_output(opts: Optional[InvokeOptions] = None) -> Output[GetIamApiClientsResult]

func GetIamApiClients(ctx *Context, opts ...InvokeOption) (*GetIamApiClientsResult, error)
func GetIamApiClientsOutput(ctx *Context, opts ...InvokeOption) GetIamApiClientsResultOutput

> Note: This function is named GetIamApiClients in the Go SDK.

public static class GetIamApiClients 
{
    public static Task<GetIamApiClientsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetIamApiClientsResult> Invoke(InvokeOptions? opts = null)
}

public static CompletableFuture<GetIamApiClientsResult> getIamApiClients(InvokeOptions options)
public static Output<GetIamApiClientsResult> getIamApiClients(InvokeOptions options)

fn::invoke:
  function: akamai:index/getIamApiClients:getIamApiClients
  arguments:
    # arguments dictionary

getIamApiClients Result

The following output properties are available:

ApiClients List<GetIamApiClientsApiClient>
Id string: The provider-assigned unique ID for this managed resource.

ApiClients []GetIamApiClientsApiClient
Id string: The provider-assigned unique ID for this managed resource.

apiClients List<GetIamApiClientsApiClient>
id String: The provider-assigned unique ID for this managed resource.

apiClients GetIamApiClientsApiClient[]
id string: The provider-assigned unique ID for this managed resource.

api_clients Sequence[GetIamApiClientsApiClient]
id str: The provider-assigned unique ID for this managed resource.

apiClients List<Property Map>
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

GetIamApiClientsApiClient

AccessToken string: The part of the client secret that identifies your API client and lets you access applications and resources.
Actions GetIamApiClientsApiClientActions: Specifies activities available for the API client.
ActiveCredentialCount int: The number of credentials active for the API client.
AllowAccountSwitch bool: Whether the API client can manage more than one account.
AuthorizedUsers List<string>: The API client's valid users.
CanAutoCreateCredential bool: Whether the API client can create a credential for a new API client.
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.
CreatedBy string: The user who created the API client.
CreatedDate string: The ISO 8601 timestamp indicating when the API client was created.
IsLocked bool: Whether the API client is locked.
NotificationEmails List<string>: Email addresses to notify users when credentials expire.
ServiceConsumerToken string: Unique identifier for the service hostname.

AccessToken string: The part of the client secret that identifies your API client and lets you access applications and resources.
Actions GetIamApiClientsApiClientActions: Specifies activities available for the API client.
ActiveCredentialCount int: The number of credentials active for the API client.
AllowAccountSwitch bool: Whether the API client can manage more than one account.
AuthorizedUsers []string: The API client's valid users.
CanAutoCreateCredential bool: Whether the API client can create a credential for a new API client.
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.
CreatedBy string: The user who created the API client.
CreatedDate string: The ISO 8601 timestamp indicating when the API client was created.
IsLocked bool: Whether the API client is locked.
NotificationEmails []string: Email addresses to notify users when credentials expire.
ServiceConsumerToken string: Unique identifier for the service hostname.

accessToken String: The part of the client secret that identifies your API client and lets you access applications and resources.
actions GetIamApiClientsApiClientActions: Specifies activities available for the API client.
activeCredentialCount Integer: The number of credentials active for the API client.
allowAccountSwitch Boolean: Whether the API client can manage more than one account.
authorizedUsers List<String>: The API client's valid users.
canAutoCreateCredential Boolean: Whether the API client can create a credential for a new API client.
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.
createdBy String: The user who created the API client.
createdDate String: The ISO 8601 timestamp indicating when the API client was created.
isLocked Boolean: Whether the API client is locked.
notificationEmails List<String>: Email addresses to notify users when credentials expire.
serviceConsumerToken String: Unique identifier for the service hostname.

accessToken string: The part of the client secret that identifies your API client and lets you access applications and resources.
actions GetIamApiClientsApiClientActions: Specifies activities available for the API client.
activeCredentialCount number: The number of credentials active for the API client.
allowAccountSwitch boolean: Whether the API client can manage more than one account.
authorizedUsers string[]: The API client's valid users.
canAutoCreateCredential boolean: Whether the API client can create a credential for a new API client.
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.
createdBy string: The user who created the API client.
createdDate string: The ISO 8601 timestamp indicating when the API client was created.
isLocked boolean: Whether the API client is locked.
notificationEmails string[]: Email addresses to notify users when credentials expire.
serviceConsumerToken string: Unique identifier for the service hostname.

access_token str: The part of the client secret that identifies your API client and lets you access applications and resources.
actions GetIamApiClientsApiClientActions: Specifies activities available for the API client.
active_credential_count int: The number of credentials active for the API client.
allow_account_switch bool: Whether the API client can manage more than one account.
authorized_users Sequence[str]: The API client's valid users.
can_auto_create_credential bool: Whether the API client can create a credential for a new API client.
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.
created_by str: The user who created the API client.
created_date str: The ISO 8601 timestamp indicating when the API client was created.
is_locked bool: Whether the API client is locked.
notification_emails Sequence[str]: Email addresses to notify users when credentials expire.
service_consumer_token str: Unique identifier for the service hostname.

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.
allowAccountSwitch Boolean: Whether the API client can manage more than one account.
authorizedUsers List<String>: The API client's valid users.
canAutoCreateCredential Boolean: Whether the API client can create a credential for a new API client.
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.
createdBy String: The user who created the API client.
createdDate String: The ISO 8601 timestamp indicating when the API client was created.
isLocked Boolean: Whether the API client is locked.
notificationEmails List<String>: Email addresses to notify users when credentials expire.
serviceConsumerToken String: Unique identifier for the service hostname.

GetIamApiClientsApiClientActions

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.
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.
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.
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.
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.
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.
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.

Package Details

Repository: Akamai pulumi/pulumi-akamai
License: Apache-2.0
Notes: This Pulumi package is based on the akamai Terraform Provider.

Akamai v10.2.0 published on Friday, Nov 14, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-akamai

akamai.getIamApiClients

On this page

On this page

Using getIamApiClients

getIamApiClients Result

Supporting Types

GetIamApiClientsApiClient

GetIamApiClientsApiClientActions

Package Details

On this page

On this page