auth0
Version:
SDK for Auth0 API v2
170 lines • 6.17 kB
JavaScript
import * as runtime from '../../../lib/runtime.js';
const { BaseAPI } = runtime;
/**
*
*/
export class KeysManager extends BaseAPI {
/**
* Delete the custom provided encryption key with the given ID and move back to using native encryption key.
* Delete the encryption key by its key id
*
* @throws {RequiredError}
*/
async deleteEncryptionKey(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['kid']);
const response = await this.request({
path: `/keys/encryption/{kid}`.replace('{kid}', encodeURIComponent(String(requestParameters.kid))),
method: 'DELETE',
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Retrieve details of the encryption key with the given ID.
* Get the encryption key by its key id
*
* @throws {RequiredError}
*/
async getEncryptionKey(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['kid']);
const response = await this.request({
path: `/keys/encryption/{kid}`.replace('{kid}', encodeURIComponent(String(requestParameters.kid))),
method: 'GET',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
async getAllEncryptionKeys(requestParameters = {}, initOverrides) {
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
]);
const response = await this.request({
path: `/keys/encryption`,
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Get an Application Signing Key by its key id
*
* @throws {RequiredError}
*/
async get(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['kid']);
const response = await this.request({
path: `/keys/signing/{kid}`.replace('{kid}', encodeURIComponent(String(requestParameters.kid))),
method: 'GET',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Get all Application Signing Keys
*
* @throws {RequiredError}
*/
async getAll(initOverrides) {
const response = await this.request({
path: `/keys/signing`,
method: 'GET',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Create the new, pre-activated encryption key, without the key material.
* Create the new encryption key
*
* @throws {RequiredError}
*/
async createEncryptionKey(bodyParameters, initOverrides) {
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/keys/encryption`,
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Import wrapped key material and activate encryption key.
* Import the encryption key
*
* @throws {RequiredError}
*/
async importEncryptionKey(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['kid']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/keys/encryption/{kid}`.replace('{kid}', encodeURIComponent(String(requestParameters.kid))),
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Perform rekeying operation on the key hierarchy.
* Rekey the key hierarchy
*
* @throws {RequiredError}
*/
async postEncryptionRekey(initOverrides) {
const response = await this.request({
path: `/keys/encryption/rekey`,
method: 'POST',
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Create the public wrapping key to wrap your own encryption key material.
* Create the public wrapping key
*
* @throws {RequiredError}
*/
async createPublicWrappingKey(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['kid']);
const response = await this.request({
path: `/keys/encryption/{kid}/wrapping-key`.replace('{kid}', encodeURIComponent(String(requestParameters.kid))),
method: 'POST',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Rotate the Application Signing Key
*
* @throws {RequiredError}
*/
async rotate(initOverrides) {
const response = await this.request({
path: `/keys/signing/rotate`,
method: 'POST',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Revoke an Application Signing Key by its key id
*
* @throws {RequiredError}
*/
async revoke(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['kid']);
const response = await this.request({
path: `/keys/signing/{kid}/revoke`.replace('{kid}', encodeURIComponent(String(requestParameters.kid))),
method: 'PUT',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
}
//# sourceMappingURL=keys-manager.js.map