Security tools

Use security tools to create, manage, and revoke API keys for programmatic authentication with Cognos Analytics.

create-login-api-key

Creates a new login API key in Cognos Analytics with a specified name and optional description.

Use this to authenticate programmatic access, set up service accounts, and create keys for integration purposes.

Important: The API key value is displayed only once upon creation and cannot be retrieved later. Save the key immediately after creation.

Sample prompt:

"Create a new API key named 'Development' with description 'For development environment'."

Your AI assistant generates the API key and displays its value.

delete-login-api-key

Deletes an existing login API key from Cognos Analytics. Use this to revoke API access or remove compromised keys. Any applications using the deleted key lose access immediately.

Sample prompt:

"Delete the API key named 'Production Key'."

Your AI assistant removes the API key and confirms the deletion.

get-login-api-key-by-id

Retrieves metadata about a specific login API key by its ID. Returns the key name, ID, status, creation date, and description. The actual API key value cannot be retrieved after creation.

Sample prompt:

"Show me details about API key 'Development'."

Your AI assistant retrieves and displays the API key metadata.

list-login-api-keys

Lists all login API keys in Cognos Analytics with their metadata. Use this to audit API key usage and manage access credentials.

Sample prompt:

"Show me all API keys."

Your AI assistant retrieves and displays all API keys with their names, IDs, and statuses.

update-login-api-key

Updates login API key properties such as name, description, or enabled or disabled status.

Sample prompt:

"Update API key name from 'Development' to 'Production Key' with description 'For production environment'."

Your AI assistant modifies the API key properties and confirms the changes.