Function ApikeysApiFactory

Returns {
    adminCreateApiKey(groupId, appId, adminCreateApiKeyRequest, options?) => AxiosPromise<ApiKey>;
    adminDeleteApiKey(groupId, appId, apiKeyId, options?) => AxiosPromise<void>;
    adminDisableApiKey(groupId, appId, apiKeyId, options?) => AxiosPromise<void>;
    adminEnableApiKey(groupId, appId, apiKeyId, options?) => AxiosPromise<void>;
    adminGetApiKey(groupId, appId, apiKeyId, options?) => AxiosPromise<ApiKeyResponse>;
    adminListApiKeys(groupId, appId, options?) => AxiosPromise<any>;
}

• adminCreateApiKey:function

  • adminCreateApiKey(groupId, appId, adminCreateApiKeyRequest, options?): AxiosPromise<ApiKey>

  • Create a new API key.

    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.

    • adminCreateApiKeyRequest: AdminCreateApiKeyRequest

      The API key to create.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<ApiKey>

    Summary

    Create a new API key

    Throws

• adminDeleteApiKey:function

  • adminDeleteApiKey(groupId, appId, apiKeyId, options?): AxiosPromise<void>

  • Delete an API key.

    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.

    • apiKeyId: any

      The unique `_id` value of an API key

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete an API key

    Throws

• adminDisableApiKey:function

  • adminDisableApiKey(groupId, appId, apiKeyId, options?): AxiosPromise<void>

  • Disable an API key.

    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.

    • apiKeyId: any

      The unique `_id` value of an API key

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Disable an API key

    Throws

• adminEnableApiKey:function

  • adminEnableApiKey(groupId, appId, apiKeyId, options?): AxiosPromise<void>

  • Enable an API key.

    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.

    • apiKeyId: any

      The unique `_id` value of an API key

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Enable an API key

    Throws

• adminGetApiKey:function

  • adminGetApiKey(groupId, appId, apiKeyId, options?): AxiosPromise<ApiKeyResponse>

  • Retrieve information about an API key.

    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.

    • apiKeyId: any

      The unique `_id` value of an API key

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<ApiKeyResponse>

    Summary

    Retrieve information about an API key

    Throws

• adminListApiKeys:function

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

  • List API keys 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 API keys

    Throws