Function SecurityApiAxiosParamCreator

Returns {
    adminCreatePrivateEndpoint: ((groupId, appId, privateEndpoint, options?) => Promise<RequestArgs>);
    adminDeletePrivateEndpoint: ((groupId, appId, privateEndpointId, options?) => Promise<RequestArgs>);
    adminGetPrivateEndpoint: ((groupId, appId, privateEndpointId, options?) => Promise<RequestArgs>);
    adminGetPrivateEndpoints: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminGetRefreshTokenExpiration: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminListAllowedRequestOrigins: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminListPrivateEndpointServices: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminSetAllowedRequestOrigins: ((groupId, appId, body, options?) => Promise<RequestArgs>);
    adminSetRefreshTokenExpiration: ((groupId, appId, refreshTokenExpiration, options?) => Promise<RequestArgs>);
    adminUpdatePrivateEndpoint: ((groupId, appId, privateEndpointId, privateEndpoint, options?) => Promise<RequestArgs>);
    allowedIPAccessListCreate: ((groupId, appId, allowedIPAccessListCreateRequest, options?) => Promise<RequestArgs>);
    allowedIPAccessListDelete: ((groupId, appId, ipId, options?) => Promise<RequestArgs>);
    allowedIPAccessListGet: ((groupId, appId, options?) => Promise<RequestArgs>);
    allowedIPAccessListUpdate: ((groupId, appId, ipId, allowedIPAccessListUpdateRequest, options?) => Promise<RequestArgs>);
}

• adminCreatePrivateEndpoint: ((groupId, appId, privateEndpoint, options?) => Promise<RequestArgs>)

  • • (groupId, appId, privateEndpoint, options?): Promise<RequestArgs>

    • Configure a new private endpoint for the 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.

      • privateEndpoint: PrivateEndpoint

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a VPC Private Endpoint

      Throws

• adminDeletePrivateEndpoint: ((groupId, appId, privateEndpointId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, privateEndpointId, options?): Promise<RequestArgs>

    • Delete a private endpoint.

      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.

      • privateEndpointId: any

        The _id ObjectID of a VPC private endpoint.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a VPC Private Endpoint

      Throws

• adminGetPrivateEndpoint: ((groupId, appId, privateEndpointId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, privateEndpointId, options?): Promise<RequestArgs>

    • Get a specific private endpoint configuration.

      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.

      • privateEndpointId: any

        The _id ObjectID of a VPC private endpoint.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a VPC Private Endpoint

      Throws

• adminGetPrivateEndpoints: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Get a list of all private endpoints configured for the 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List VPC Private Endpoints

      Throws

• adminGetRefreshTokenExpiration: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Get the current expiration time in seconds for user session refresh tokens.

      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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get User Refresh Token Expiration Time

      Throws

• adminListAllowedRequestOrigins: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • List the allowed HTTP origins from which App Services should allow requests.

      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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List allowed HTTP origins

      Throws

• adminListPrivateEndpointServices: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Get a list of all private endpoint services configured for the 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List VPC Private Endpoint Services

      Throws

• adminSetAllowedRequestOrigins: ((groupId, appId, body, options?) => Promise<RequestArgs>)

  • • (groupId, appId, body, options?): Promise<RequestArgs>

    • Set the allowed HTTP origins from which App Services should allow requests.

      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.

      • body: any

        A list of HTTP origins.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Set allowed HTTP origins

      Throws

• adminSetRefreshTokenExpiration: ((groupId, appId, refreshTokenExpiration, options?) => Promise<RequestArgs>)

  • • (groupId, appId, refreshTokenExpiration, options?): Promise<RequestArgs>

    • Set the expiration time in seconds for user session refresh tokens.

      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.

      • refreshTokenExpiration: RefreshTokenExpiration

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Set User Refresh Token Expiration Time

      Throws

• adminUpdatePrivateEndpoint: ((groupId, appId, privateEndpointId, privateEndpoint, options?) => Promise<RequestArgs>)

  • • (groupId, appId, privateEndpointId, privateEndpoint, options?): Promise<RequestArgs>

    • Update the configuration of a private endpoint.

      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.

      • privateEndpointId: any

        The _id ObjectID of a VPC private endpoint.

      • privateEndpoint: PrivateEndpoint

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Modify a VPC Private Endpoint

      Throws

• allowedIPAccessListCreate: ((groupId, appId, allowedIPAccessListCreateRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, allowedIPAccessListCreateRequest, options?): Promise<RequestArgs>

    • Create an IP address or CIDR block in the Access List for your 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.

      • allowedIPAccessListCreateRequest: AllowedIPAccessListCreateRequest

        The IP Access List entry to create.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create an IP address or CIDR block in the Access List

      Throws

• allowedIPAccessListDelete: ((groupId, appId, ipId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, ipId, options?): Promise<RequestArgs>

    • Delete an IP address or CIDR block from the Access List of your 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.

      • ipId: any

        The IP address entry denoted by `ip_id` with the information given in the request body

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete an IP address or CIDR block from the Access List

      Throws

• allowedIPAccessListGet: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • List the allowed entries in the Access List of your 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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List the allowed entries in the Access List

      Throws

• allowedIPAccessListUpdate: ((groupId, appId, ipId, allowedIPAccessListUpdateRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, ipId, allowedIPAccessListUpdateRequest, options?): Promise<RequestArgs>

    • Modify an IP address or CIDR block in the Access List of your 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.

      • ipId: any

        The IP address entry denoted by `ip_id` with the information given in the request body

      • allowedIPAccessListUpdateRequest: AllowedIPAccessListUpdateRequest

        The updated value of the IP Access List entry.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Modify an IP address or CIDR block in the Access List

      Throws