Sign in
apiCredentials

Update an API Credential

Update the specified API Credential.

patch/v1/organizations/{organizationId}/api-credentials/{apiCredentialId}

Path parameters

organizationIdstring required

The <code>id</code> of the Organization whose API Credential you want to update.

apiCredentialIdstring required

The <code>clientId</code> of the API Credential to update.

Request body

namestring

Human-readable name of the API Credential.

descriptionstring

Brief description of the purpose and usage for the API Credential.

enabledboolean

If <code>true</code>, the API Credential is enabled. Otherwise, <code>false</code>.

ipAllowliststring[]

Omit to leave unchanged. Pass an empty array to clear the stored IP allowlist.

Example request

{
  "name": "Auto-Manage-Workspaces",
  "description": "Used for automated Workspace management",
  "enabled": true,
  "roles": {
    "workspaces": [
      {
        "workspaceId": "main"
      }
    ]
  },
  "ipAllowlist": [
    "10.0.0.1/32"
  ]
}

Response

API Credential updated

Changes

Changed in 6 of the 41 revisions of this API.125

  • 6129323514c11See the full diff
    • ○

      added the new insights enum value to the request property roles/allOf[ApiCredentialRolesSchema]/workspaces/items/products/items/product/allOf[ProductName]/

      request-property-enum-value-added

  • 53d0b0012c3a1See the full diff
    • ○

      added the new optional request property ipAllowlist

      new-optional-request-property

  • aecdd0a7e96c2See the full diff
    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • 5289d0eff8a31See the full diff
    • ●

      the name request property's maxLength was set to 140

      request-property-max-length-set

  • bfa460b2aec311See the full diff
    • ▲

      added the pattern ^[A-Za-z0-9-]+$ to the request property name

      request-property-pattern-added

    • ●

      the description request property's maxLength was set to 140

      request-property-max-length-set

  • f2d7d1ad34951See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog