manage_auth_methods
Create, list, update, and delete authentication methods with security controls like IP whitelisting, MFA, and access expiration for CipherTrust secrets management.
Instructions
AUTHENTICATION METHODS MANAGEMENT TOOL - Create, manage, and secure authentication methods
SUPPORTED ACTIONS: • create_api_key: Create API key authentication methods with IP restrictions and expiration • create_email: Create email-based authentication methods with MFA support • list: List all authentication methods with filtering and pagination • get: Retrieve detailed authentication method configuration and status • update: Modify authentication method properties, credentials, and settings • delete: Delete individual authentication methods with proper cleanup • delete_auth_methods: Bulk delete authentication methods within a specific path
SECURITY FEATURES: • IP address restrictions and CIDR whitelisting • Access expiration and JWT TTL management • Multi-factor authentication (MFA) support • Audit logging and compliance tracking • Delete protection and access control
Example: Create a secure API key for application authentication
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| json | No | Set output format to JSON | |
| name | No | Authentication method name (required for create_api_key, update, delete, get) | |
| path | No | Path for bulk operations (required for delete_auth_methods) | |
| tags | No | List of tags attached to this object | |
| type | No | Auth method types to filter by [api_key, azure_ad, oauth2/jwt, saml2, ldap, aws_iam, oidc, universal_identity, gcp, k8s, cert] | |
| No | Email address for email authentication method | ||
| action | Yes | Authentication method management action to perform. SUPPORTED ACTIONS: 'create_api_key' (create API key authentication), 'create_email' (create email authentication), 'list' (list all authentication methods), 'get' (retrieve specific auth method details), 'update' (modify auth method properties), 'delete' (delete individual auth method), 'delete_auth_methods' (bulk delete auth methods by path) | |
| filter | No | Filter by auth method name or part of it | |
| jwt_ttl | No | JWT TTL | |
| mfa_type | No | Enable two-factor-authentication via [email/auth app] | |
| new_name | No | New name for the authentication method (for update action) | |
| bound_ips | No | CIDR whitelist for IP restrictions | |
| enable_mfa | No | Enable MFA for this authentication method [True/False] | |
| description | No | Auth Method description | |
| gw_bound_ips | No | CIDR whitelist for Gateway IP restrictions | |
| product_type | No | Product type for auth method [sm, sra, pm, dp, ca] | |
| accessibility | No | Accessibility level | regular |
| access_expires | No | Access expiration date in Unix timestamp (0 for no expiry) | |
| force_sub_claims | No | Enforce role-association must include sub claims | |
| pagination_token | No | Next page reference | |
| audit_logs_claims | No | Subclaims to include in audit logs | |
| delete_protection | No | Protection from accidental deletion [true/false] | |
| expiration_event_in | No | Days before expiration to be notified |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||