API clients

akamai_iam_api_clients

As an account administrator, get a list of API clients you can manage.

data "akamai_iam_api_clients" "my-api-clients" {
}

output "my-api-clients" {
  value = data.akamai_iam_api_clients.my-api-clients
}

Changes to Outputs:
  + my-api-clients = {
      api_clients = [
        + {
              + access_token               = "akab-ab1cdefghijk2-3lmn4opqrstu5vwxy67"
              + actions                    = {
                  + deactivate_all = false
                  + delete         = true
                  + edit           = true
                  + lock           = true
                  + transfer       = true
                  + unlock         = false
                }
              + active_credential_count    = 0
              + allow_account_switch       = false
              + authorized_users           = [
                  + "jsmith@email.com",
                ]
              + can_auto_create_credential = false
              + client_description         = "My-API-Client-1"
              + client_id                  = "123abcdefgh45ij"
              + client_name                = "jsmith"
              + client_type                = "CLIENT"
              + created_by                 = "jsmith@email.com"
              + created_date               = "2024-06-09T14:18:46Z"
              + is_locked                  = false
              + notification_emails        = [
                  + "jsmith@akamai.com",
                ]
              + service_consumer_token     = "akab-abcdefghijklm1no-pqrstuvwxyza2b3c"
            },
          + {
              + access_token               = "akab-zyxwvutsrq9po-n76mlkjih8gfe76d54c"
              + actions                    = {
                  + deactivate_all = true
                  + delete         = false
                  + edit           = true
                  + lock           = true
                  + transfer       = true
                  + unlock         = false
                }
              + active_credential_count    = 1
              + allow_account_switch       = true
              + authorized_users           = [
                  + "jasmith@email.com",
                ]
              + can_auto_create_credential = false
              + client_description         = "My-API-Client-2"
              + client_id                  = "98zyxwvutsr7qp"
              + client_name                = "jasmith"
              + client_type                = "USER_CLIENT"
              + created_by                 = "jasmith@email.com"
              + created_date               = "2025-01-30T19:44:32Z"
              + is_locked                  = false
              + notification_emails        = [
                  + "jasmith@email.com",
                ]
              + service_consumer_token     = "akab-zyxwvutsrqpo98-n76mlk5j543ihgfe2d10"
            },
      ]
    }

Arguments

This data source is passed empty. The config_section argument in the Akamai provider block of your Terraform configuration provides the necessary information.

Attributes

Returned to you is a set of api_clients with their details.

Attribute	Description
`access_token`	The API client's access token.
`actions`	Actions available on the API client. When set to `true`, you can perform a given action on the API client. Includes: `delete`. Enables you to remove the API client. `deactivate_all`. Enables you to deactivate the API client's credentials. `edit`. Enables you to update the API client. `lock`. Enables you to lock the API client. `transfer`. Enables you to transfer the API client to a new owner. `unlock`. Enables you to unlock the API client.
`active_credential_count`	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`	When set to `true`, the API client can manage more than one account. See Switch account for details.
`authorized_users`	The API client's valid users.
`can_auto_create_credential`	When set to `true`, the API client can create a credential for a new API client.
`client_description`	A human-readable description of the API client.
`client_id`	The API client's ID.
`client_name`	A human-readable name for the API client.
`client_type`	The API client's ownership and credential management. Possible values: `CLIENT`. Indicates the creator owns and manages the credentials. It's a default value. `USER_CLIENT`. Indicates another user owns the client and manages the credentials. `SERVICE_ACCOUNT`. Indicates only authorized users can manage the client's credentials.
`created_by`	The user who created the API client.
`created_date`	The ISO 8601 timestamp indicating when the API client was created.
`is_locked`	When set to `true`, the API client is locked.
`notification_emails`	Email addresses of users who get notified when credentials expire.
`service_consumer_token`	The service hostname's ID.

Updated 8 days ago