Function SecretsApiFactory

Returns {
    adminCreateASecret(groupId, appId, adminCreateASecretRequest, options?) => AxiosPromise<AdminCreateRule201Response>;
    adminDeleteSecret(groupId, appId, secretId, options?) => AxiosPromise<void>;
    adminGetAllSecrets(groupId, appId, options?) => AxiosPromise<any>;
    adminModifyASecret(groupId, appId, secretId, adminModifyASecretRequest, options?) => AxiosPromise<void>;
}

• adminCreateASecret:function

  • adminCreateASecret(groupId, appId, adminCreateASecretRequest, options?): AxiosPromise<AdminCreateRule201Response>

  • Create a new Secret.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • adminCreateASecretRequest: AdminCreateASecretRequest

      The Secret to create.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AdminCreateRule201Response>

    Summary

    Create a new Secret

    Throws

• adminDeleteSecret:function

  • adminDeleteSecret(groupId, appId, secretId, options?): AxiosPromise<void>

  • Delete a Secret associated with a Atlas App Services App.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • secretId: any

      The unique `_id` value of a secret.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a Secret

    Throws

• adminGetAllSecrets:function

  • adminGetAllSecrets(groupId, appId, options?): AxiosPromise<any>

  • List secrets associated with a Atlas App Services App.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List secrets

    Throws

• adminModifyASecret:function

  • adminModifyASecret(groupId, appId, secretId, adminModifyASecretRequest, options?): AxiosPromise<void>

  • Modify a Secret associated with a Atlas App Services App.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • secretId: any

      The unique `_id` value of a secret.

    • adminModifyASecretRequest: AdminModifyASecretRequest

      The modified value of the Secret.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Modify a Secret

    Throws