Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IntegrationsKmsProfilesApi

IntegrationsKmsProfilesApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • IntegrationsKmsProfilesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

createanewkeyManagementserviceKMSprofile

  • Creates a new KMS profile. Returns the created KMS profile, without the API key. Requires admin privileges. For more information about the KMS profiles, see ibmaspera.com/help/admin/nodes/ssear_kms_managed_keys.

    summary

    Create a new key-management service (KMS) profile

    throws

    {RequiredError}

    memberof

    IntegrationsKmsProfilesApi

    Parameters

    Returns Promise<AxiosResponse<KmsProfileResponse>>

deletethekeyManagementserviceKMSprofile

  • Returns the deleted KMS profile for the specified kms_profile_id, without the API key. Requires admin privileges. For more information about the KMS profiles, see ibmaspera.com/help/admin/nodes/ssear_kms_managed_keys.

    summary

    Delete the key-management service (KMS) profile

    throws

    {RequiredError}

    memberof

    IntegrationsKmsProfilesApi

    Parameters

    Returns Promise<AxiosResponse<KmsProfileResponseDelete>>

getalistofallkeyManagementserviceKMSprofiles

  • getalistofallkeyManagementserviceKMSprofiles(options?: any): Promise<AxiosResponse<KmsProfileResponse[]>>

  • Returns a list of all KMS profiles, without the API key. Requires admin privileges. For more information about the KMS profiles, see ibmaspera.com/help/admin/nodes/ssear_kms_managed_keys.

    summary

    Get a list of all key-management service (KMS) profiles

    throws

    {RequiredError}

    memberof

    IntegrationsKmsProfilesApi

    Parameters

    • Optional options: any

    Returns Promise<AxiosResponse<KmsProfileResponse[]>>

getalistofnodesassociatedwiththespecifiedkeyManagementserviceKMSprofile

getthekeyManagementserviceKMSprofile

  • Returns the created KMS profile for the specified kms_profile_id, without the API key. Requires admin privileges. For more information about the KMS profiles, see ibmaspera.com/help/admin/nodes/ssear_kms_managed_keys.

    summary

    Get the key-management service (KMS) profile

    throws

    {RequiredError}

    memberof

    IntegrationsKmsProfilesApi

    Parameters

    Returns Promise<AxiosResponse<KmsProfileResponse>>

updatethekeyManagementserviceKMSprofile

  • Returns the updated KMS profile, without the API key. Requires admin privileges. For more information about the KMS profiles, see ibmaspera.com/help/admin/nodes/ssear_kms_managed_keys.

    summary

    Update the key-management service (KMS) profile

    throws

    {RequiredError}

    memberof

    IntegrationsKmsProfilesApi

    Parameters

    Returns Promise<AxiosResponse<void>>