ApiKey

Update API Key

Changed on

Updated limited API key fields

patch/apiKeys/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/apiKeys/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The ID of the API key to remove (legacy key or ID)

Query parameters

with_secretboolean

True if raw key should be returned

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

idstring

The ID of the API key, NOT the raw API Key secret

secret_keystring

secret API key (may not be returned from all endpoints)

secret_key_hashstring

Secure key hash (may not be returned from all endpoints)

secret_key_hash_cypherstring

Secure key hash type (may not be returned from all endpoints)

encrypted_secret_keystring

Encrypted secret API key (may not be returned from all endpoints)

created_timeinteger

Time at which the API key was created

created_by_idstring

The ID of the user who created this API key

deleted_timeinteger

Time at which the API key was deleted

deleted_by_idstring

The ID of the client/user who deleted this API key

expiration_timeinteger

Time at which this API key will expire

last_updated_timeinteger

Time at which the organization API key was last updated

last_updated_by_idstring

The ID of the user who last updated this API key

organization_idstring

DEPRECATED - The ID of the organization associated with this API key

namestring

Friendly name for this API key

type'agent_review' | 'ci_cd_integration' | 'command_line_interface' | 'custom' | 'database_query_execution' | 'deployment_trigger' | 'editor' | 'execution' | 'impersonation' | 'integration' | 'issue_tracker' | 'link_agent' | 'login' | 'reporting' | 'selenium_agent' | 'test_authoring' | 'usage_analytics' | 'user_management' | 'viewer' | 'workspace_admin' | 'workspace_assistant' | 'workspace_invitation_acceptance' | 'workspace_lifecycle' | 'workspace_setup'

The intended use of this API key

enabledboolean

False if key authentication should be paused

workspace_idstring

The ID of the workspace associated with this API key. Mutually exclusive with company_id.

company_idstring

The ID of the company associated with this API key. Set for company-scoped keys that grant access to all workspaces owned by the company. Mutually exclusive with workspace_id.

agent_type'test_authoring' | 'flow_authoring' | 'test_creation_planning' | 'test_planning' | 'agent_review' | 'app_summary' | 'test_run_analysis' | 'test_recovery' | 'runtime_recovery_summary_agent' | 'plan_run_analysis' | 'deployment_analysis' | 'workspace_results_analysis' | 'results_auto_analysis' | 'workspace_assistant' | 'app_modeling' | 'app_modeling_run' | 'file_assertion' | 'test_impact' | 'test_impact_shadow' | 'repair_notes'
agent_session_idstring

The agent session this key was minted for

agent_root_session_idstring

The top-level agent session of the chain this key's session belongs to

agent_parent_session_idstring

The agent session that started this key's session, if any

agent_instance_idstring

The agent cloud instance this key was minted for. Keys bound to an instance are deleted when it ends.

agent_workspace_idstring

The workspace the agent session runs in. JWTs exchanged from this key are bound to it.

agent_principal_is_support_adminboolean

The agent acts for a support admin, who is granted support access to the session workspace only.

agent_root_api_key_idstring

The API key the agent acts for, when its session was started with a key rather than by a person. JWTs exchanged from this key act as that key, limited to the agent type ceiling.

Response

API key with patches applied

idstring

The ID of the API key, NOT the raw API Key secret

secret_keystring

secret API key (may not be returned from all endpoints)

secret_key_hashstring

Secure key hash (may not be returned from all endpoints)

secret_key_hash_cypherstring

Secure key hash type (may not be returned from all endpoints)

encrypted_secret_keystring

Encrypted secret API key (may not be returned from all endpoints)

created_timeinteger

Time at which the API key was created

created_by_idstring

The ID of the user who created this API key

deleted_timeinteger

Time at which the API key was deleted

deleted_by_idstring

The ID of the client/user who deleted this API key

expiration_timeinteger

Time at which this API key will expire

last_updated_timeinteger

Time at which the organization API key was last updated

last_updated_by_idstring

The ID of the user who last updated this API key

organization_idstring

DEPRECATED - The ID of the organization associated with this API key

namestring

Friendly name for this API key

type'agent_review' | 'ci_cd_integration' | 'command_line_interface' | 'custom' | 'database_query_execution' | 'deployment_trigger' | 'editor' | 'execution' | 'impersonation' | 'integration' | 'issue_tracker' | 'link_agent' | 'login' | 'reporting' | 'selenium_agent' | 'test_authoring' | 'usage_analytics' | 'user_management' | 'viewer' | 'workspace_admin' | 'workspace_assistant' | 'workspace_invitation_acceptance' | 'workspace_lifecycle' | 'workspace_setup'

The intended use of this API key

enabledboolean

False if key authentication should be paused

workspace_idstring

The ID of the workspace associated with this API key. Mutually exclusive with company_id.

company_idstring

The ID of the company associated with this API key. Set for company-scoped keys that grant access to all workspaces owned by the company. Mutually exclusive with workspace_id.

agent_type'test_authoring' | 'flow_authoring' | 'test_creation_planning' | 'test_planning' | 'agent_review' | 'app_summary' | 'test_run_analysis' | 'test_recovery' | 'runtime_recovery_summary_agent' | 'plan_run_analysis' | 'deployment_analysis' | 'workspace_results_analysis' | 'results_auto_analysis' | 'workspace_assistant' | 'app_modeling' | 'app_modeling_run' | 'file_assertion' | 'test_impact' | 'test_impact_shadow' | 'repair_notes'
agent_session_idstring

The agent session this key was minted for

agent_root_session_idstring

The top-level agent session of the chain this key's session belongs to

agent_parent_session_idstring

The agent session that started this key's session, if any

agent_instance_idstring

The agent cloud instance this key was minted for. Keys bound to an instance are deleted when it ends.

agent_workspace_idstring

The workspace the agent session runs in. JWTs exchanged from this key are bound to it.

agent_principal_is_support_adminboolean

The agent acts for a support admin, who is granted support access to the session workspace only.

agent_root_api_key_idstring

The API key the agent acts for, when its session was started with a key rather than by a person. JWTs exchanged from this key act as that key, limited to the agent type ceiling.

Changes

  • 67dadb3fba24Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 0ddfcf08c4a8Revision changes
    • warning

      added the new workspace_assistant enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new workspace_assistant enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status