Loading TOC...

Management API (Security)

For the complete list of REST resources in this category, refer to the main Management API page.

77 resources
Resource URI Description
/manage/v2/amps (GET) This resource address returns a summary of the amps in the security database.
/manage/v2/amps (POST) This resource address creates a new amp in the Security database.
/manage/v2/amps/{id|name} (DELETE) This resource address deletes the named amp from the named security database.
/manage/v2/amps/{id|name} (GET) This resource address returns the configuration for the specified amp.
/manage/v2/amps/{id|name}/properties (GET) This resource address returns the properties of the specified amp.
/manage/v2/amps/{id|name}/properties (PUT) This resource address can be used to update the properties for the specified amp.
/manage/v2/certificate-authorities (GET) This resource address returns a summary of the certificate authorities in the cluster.
/manage/v2/certificate-authorities (POST) This resource address creates a new certificate authority in the security database.
/manage/v2/certificate-authorities/{id|name} (DELETE) This resource address deletes the named certificate authority from the Security database.
/manage/v2/certificate-authorities/{id|name} (GET) This resource address returns the configuration for the specified certificate authority.
/manage/v2/certificate-authorities/{id|name}/properties (GET) This resource address returns the properties of the specified certificate authority.
/manage/v2/certificate-revocation-lists (PUT) This resource address inserts a PEM- or DER-encoded Certificate Revocation List (CRL) into the security database.
/manage/v2/certificate-templates (GET) This resource address returns a summary of the certificate templates in the cluster.
/manage/v2/certificate-templates (POST) This resource address creates a new certificate template in the Security database.
/manage/v2/certificate-templates/{id|name} (DELETE) This resource address deletes the named certificate template from the Security database.
/manage/v2/certificate-templates/{id|name} (GET) This resource address returns the configuration for the specified certificate template.
/manage/v2/certificate-templates/{id|name} (POST) This resource address is used to perform various operations on the specified certificate template.
/manage/v2/certificate-templates/{id|name}/properties (GET) This resource address returns the properties of the specified certificate template.
/manage/v2/certificate-templates/{id|name}/properties (PUT) This resource address can be used to update the properties for the specified certificate template.
/manage/v2/certificates (GET) This resource address returns a summary of the certificates in the cluster.
/manage/v2/certificates (POST) This resource address inserts one or more certificates into the Security database.
/manage/v2/certificates/{id|name} (DELETE) This resource address deletes the named certificate from the Security database.
/manage/v2/certificates/{id|name} (GET) This resource address returns the configuration for the specified certificate.
/manage/v2/certificates/{id|name}/properties (GET) This resource address returns the properties of the specified certificate.
/manage/v2/credentials/properties (DELETE) Delete credentials used to access external services, such as Amazon Web Services (AWS).
/manage/v2/credentials/properties (GET) Retrieve credentials used to access external services, such as Amazon Web Services (AWS).
/manage/v2/credentials/properties (PUT) This resource address sets the credentials used to access external services, such as Amazon Web Services (AWS).
/manage/v2/credentials/secure (GET) Retrieve secure credentials.
/manage/v2/credentials/secure (POST) This resource address sets a secure credential.
/manage/v2/external-security (GET) This resource address returns a summary of the external-security configurations in the security database.
/manage/v2/external-security (POST) This resource address creates a new external-security configuration in the security database.
/manage/v2/external-security/{id|name} (DELETE) This resource address deletes the named external-security configuration from the named security database.
/manage/v2/external-security/{id|name} (GET) This resource address returns the specified external-security configuration.
/manage/v2/external-security/{id|name}/jwt-secrets (DELETE) This resource address deletes the JWT secret with the specified key-IDs given in the payload from the specified external security configuration.
/manage/v2/external-security/{id|name}/jwt-secrets (POST) This resource address can be used to add JWT secrets for the specified external security configuration.
/manage/v2/external-security/{id|name}/jwt-secrets (PUT) This resource address can be used to update the JWT secrets for the specified external security configuration.
/manage/v2/external-security/{id|name}/properties (GET) This resource address returns the properties of the specified external-security configuration.
/manage/v2/external-security/{id|name}/properties (PUT) This resource address can be used to update the properties for the specified external-security configuration.
/manage/v2/privileges (GET) This resource address returns a summary of the privileges in the security database.
/manage/v2/privileges (POST) This resource address creates a new privilege in the security database.
/manage/v2/privileges/{id|name} (DELETE) This resource address deletes the named privilege from the named security database.
/manage/v2/privileges/{id|name} (GET) This resource address returns the configuration for the specified privilege.
/manage/v2/privileges/{id|name}/properties (GET) This resource address returns the properties of the specified privilege.
/manage/v2/privileges/{id|name}/properties (PUT) This resource address can be used to update the properties for the specified privilege.
/manage/v2/protected-collections (GET) This resource address returns a summary of the protected collections in the cluster.
/manage/v2/protected-collections (POST) This resource address creates a new protected collection in the security database.
/manage/v2/protected-collections?collection={collection-uri} (DELETE) This resource address deletes the named protected collection from the Security database.
/manage/v2/protected-collections?collection={collection-uri} (GET) This resource address returns the configuration for the specified protected collection.
/manage/v2/protected-collections/properties?collection={collection-uri} (GET) This resource address returns the properties of the specified protected collection.
/manage/v2/protected-collections/properties?collection={collection-uri} (PUT) This resource address can be used to update the properties for the specified protected collection.
/manage/v2/protected-paths (GET) This resource endpoint retrieves a list of protected paths.
/manage/v2/protected-paths (POST) This resource endpoint creates a new protected path using a name or id passed in a payload.
/manage/v2/protected-paths/{id}/properties (GET) This resource endpoint retrieves the properties of specific protected path.
/manage/v2/protected-paths/{id}/properties (PUT) This resource endpoint updates one or more properties of a protected path.
/manage/v2/protected-paths/{id|name} (DELETE) This resource endpoint deletes a given protected path using a name or id passed in the URL.
/manage/v2/protected-paths/{id|name} (GET) This resource endpoint retrieves a given protected path.
/manage/v2/query-rolesets (GET) This resource endpoint retrieves a list of query rolesets.
/manage/v2/query-rolesets (POST) This resource endpoint creates a new query roleset.
/manage/v2/query-rolesets/{id} (DELETE) This resource endpoint deletes a given query roleset using the id passed in the URL.
/manage/v2/query-rolesets/{id} (GET) This resource endpoint retrieves a given query roleset.
/manage/v2/query-rolesets/{id}/properties (GET) This resource endpoint retrieves a given query roleset.
/manage/v2/roles (GET) This resource address returns a summary of the roles in the security database.
/manage/v2/roles (POST) This resource address creates a new role in the security database.
/manage/v2/roles/{id|name} (DELETE) This resource address deletes the named role from the named security database.
/manage/v2/roles/{id|name} (GET) This resource address returns the configuration for the specified role.
/manage/v2/roles/{id|name}/properties (GET) This resource address returns the properties of the specified role.
/manage/v2/roles/{id|name}/properties (PUT) This resource address can be used to update the properties for the specified role.
/manage/v2/security (GET) Retrieve a summary of security information for the cluster.
/manage/v2/security (POST) Perform a security operation such as rotating configuration, data, or log encryption keys.
/manage/v2/security/properties (GET) Retrieve security properties for a cluster.
/manage/v2/security/properties (PUT) Update security properties.
/manage/v2/users (GET) This resource address returns a summary of the users in the cluster.
/manage/v2/users (POST) This resource address creates a new user in the security database.
/manage/v2/users/{id|name} (DELETE) This resource address deletes the named user from the named security database.
/manage/v2/users/{id|name} (GET) This resource address returns the configuration for the specified user.
/manage/v2/users/{id|name}/properties (GET) This resource address returns the properties of the specified user.
/manage/v2/users/{id|name}/properties (PUT) This resource address can be used to update the properties for the specified user.