---
updatedAt: 2026-04-20T19:33:34.000Z
---

# Modify an API client

Modifies permissions and settings for an API client.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Clients",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}"
    }
  ],
  "paths": {
    "/config/{app_id}/clients/{client_id}": {
      "put": {
        "operationId": "put-client",
        "summary": "Modify an API client",
        "description": "Modifies permissions and settings for an API client.",
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "name": "Documentation Login Client",
                "features": [
                  "login_client"
                ]
              },
              "schema": {
                "type": "object",
                "description": "Creates an API client.\n",
                "properties": {
                  "name": {
                    "description": "Name of the API client.\n",
                    "example": "Documentation Client",
                    "type": "string"
                  },
                  "ipWhitelist": {
                    "description": "CIDR blocks allowed to interact with the client. If you don't configure `ipWhitelist` the value defaults to `0.0.0.0/0`, which allows any IP address to interact with the client.\n",
                    "example": [
                      "192.168.10.0/30"
                    ],
                    "type": "array",
                    "items": {
                      "type": "string",
                      "description": "CIDR block allowed to interact with the client\n"
                    }
                  },
                  "features": {
                    "description": "Features assigned to the API client. Features determine the permissions and privileges assigned to the client.\n",
                    "example": [
                      "login_client"
                    ],
                    "type": "array",
                    "items": {
                      "type": "string",
                      "description": "Feature assigned to the client. If you assign the `login_client` feature you can't assign any other features to that client.\n",
                      "enum": [
                        "access_issuer",
                        "direct_access",
                        "direct_access_read",
                        "login_client",
                        "owner"
                      ]
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "_id": "3bchk5hsx6v58dkn288nbybmxfyk32u7",
                  "_secret": "j383npa9g4hfdye9t5es72x8r374tdfh",
                  "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/3bchk5hsx6v58dkn288nbybmxfyk32u7",
                  "_settings": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/3bchk5hsx6v58dkn288nbybmxfyk32u7/settings",
                  "name": "Documentation Login Client",
                  "features": [
                    "login_client"
                  ],
                  "ipWhitelist": [
                    "0.0.0.0/0"
                  ]
                },
                "schema": {
                  "type": "object",
                  "description": "Updates permissions and settings for an API client.\n",
                  "required": [
                    "_id",
                    "_secret",
                    "_self",
                    "_settings",
                    "features",
                    "ipWhitelist",
                    "name"
                  ],
                  "properties": {
                    "_id": {
                      "description": "Unique identifier of the API client.\n",
                      "example": null,
                      "type": "string"
                    },
                    "_secret": {
                      "description": "API client secret. The secret serves as the API client password.\n",
                      "example": "US Login Client",
                      "type": "string"
                    },
                    "_self": {
                      "description": "Path used to directly access the client in an API operation.\n",
                      "example": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/ay6e3qmucvdyr29hmpvxjdjupe8bcsky",
                      "type": "string"
                    },
                    "_settings": {
                      "description": "Path used to directly access the client settings in an API operation.\n",
                      "example": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/ed7absqep5rffbmqx89c9mwexqvbnfnk/settings",
                      "type": "string"
                    },
                    "features": {
                      "description": "Administrative features to be assigned to the client. Features control access to user records and to management tools. For example, the `owner` feature provides access to all user records while the `login_client` feature only allows access to records associated with the authenticated user.\n",
                      "example": [
                        "direct_access"
                      ],
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "Feature to be assigned. You can assign multiple features to a single client. However, if you assign the `login_client` feature to a client that's the only feature you can assign to the client.\n",
                        "enum": [
                          "access_issuer",
                          "direct_access",
                          "direct_access_read",
                          "login_client",
                          "owner"
                        ]
                      }
                    },
                    "ipWhitelist": {
                      "description": "CIDR blocks that comprise the client's IP allowlist. Only IP addresses found on the allowlist can use the client to make API operations. To use any IP address with a client, set the allowlist to `0.0.0.0/0`.\n",
                      "example": [
                        "192.168.1.0/30"
                      ],
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "CIDR block being assigned to the allowlist.\n"
                      }
                    },
                    "name": {
                      "description": "Name of the API client.\n",
                      "example": "US Login Client",
                      "type": "string"
                    }
                  }
                }
              }
            },
            "description": "Successful response\n"
          }
        }
      },
      "parameters": [
        {
          "description": "Unique identifier of the API client.\n",
          "in": "path",
          "name": "client_id",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "$ref": "#/paths/~1config~1%7Bapp_id%7D~1clients/parameters/0"
        }
      ]
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "python",
      "node"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "externalDocs": {
    "url": "https://techdocs.akamai.com/identity-cloud-config/reference",
    "description": "See documention for Akamai's Identity Cloud: Configuration API\n"
  }
}
```

# Sibling pages

* [Delete a client](https://techdocs.akamai.com/identity-cloud-config/reference/delete-client.md)
* [View an API client](https://techdocs.akamai.com/identity-cloud-config/reference/get-client.md)