Function SecurityApiFactory

Returns {
    adminCreatePrivateEndpoint(groupId, appId, privateEndpoint, options?) => AxiosPromise<void>;
    adminDeletePrivateEndpoint(groupId, appId, privateEndpointId, options?) => AxiosPromise<void>;
    adminGetPrivateEndpoint(groupId, appId, privateEndpointId, options?) => AxiosPromise<PrivateEndpoint>;
    adminGetPrivateEndpoints(groupId, appId, options?) => AxiosPromise<any>;
    adminGetRefreshTokenExpiration(groupId, appId, options?) => AxiosPromise<RefreshTokenExpiration>;
    adminListAllowedRequestOrigins(groupId, appId, options?) => AxiosPromise<any>;
    adminListPrivateEndpointServices(groupId, appId, options?) => AxiosPromise<any>;
    adminSetAllowedRequestOrigins(groupId, appId, body, options?) => AxiosPromise<void>;
    adminSetRefreshTokenExpiration(groupId, appId, refreshTokenExpiration, options?) => AxiosPromise<void>;
    adminUpdatePrivateEndpoint(groupId, appId, privateEndpointId, privateEndpoint, options?) => AxiosPromise<void>;
    allowedIPAccessListCreate(groupId, appId, allowedIPAccessListCreateRequest, options?) => AxiosPromise<AllowedIPAccessListCreate201Response>;
    allowedIPAccessListDelete(groupId, appId, ipId, options?) => AxiosPromise<void>;
    allowedIPAccessListGet(groupId, appId, options?) => AxiosPromise<any>;
    allowedIPAccessListUpdate(groupId, appId, ipId, allowedIPAccessListUpdateRequest, options?) => AxiosPromise<AllowedIPAccessListCreate201Response>;
}

• adminCreatePrivateEndpoint:function

  • adminCreatePrivateEndpoint(groupId, appId, privateEndpoint, options?): AxiosPromise<void>

  • 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: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Create a VPC Private Endpoint

    Throws

• adminDeletePrivateEndpoint:function

  • adminDeletePrivateEndpoint(groupId, appId, privateEndpointId, options?): AxiosPromise<void>

  • 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: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a VPC Private Endpoint

    Throws

• adminGetPrivateEndpoint:function

  • adminGetPrivateEndpoint(groupId, appId, privateEndpointId, options?): AxiosPromise<PrivateEndpoint>

  • 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: any

      Override http request option.

    Returns AxiosPromise<PrivateEndpoint>

    Summary

    Get a VPC Private Endpoint

    Throws

• adminGetPrivateEndpoints:function

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

  • 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: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List VPC Private Endpoints

    Throws

• adminGetRefreshTokenExpiration:function

  • adminGetRefreshTokenExpiration(groupId, appId, options?): AxiosPromise<RefreshTokenExpiration>

  • 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: any

      Override http request option.

    Returns AxiosPromise<RefreshTokenExpiration>

    Summary

    Get User Refresh Token Expiration Time

    Throws

• adminListAllowedRequestOrigins:function

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

  • 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: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List allowed HTTP origins

    Throws

• adminListPrivateEndpointServices:function

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

  • 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: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List VPC Private Endpoint Services

    Throws

• adminSetAllowedRequestOrigins:function

  • adminSetAllowedRequestOrigins(groupId, appId, body, options?): AxiosPromise<void>

  • 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: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Set allowed HTTP origins

    Throws

• adminSetRefreshTokenExpiration:function

  • adminSetRefreshTokenExpiration(groupId, appId, refreshTokenExpiration, options?): AxiosPromise<void>

  • 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: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Set User Refresh Token Expiration Time

    Throws

• adminUpdatePrivateEndpoint:function

  • adminUpdatePrivateEndpoint(groupId, appId, privateEndpointId, privateEndpoint, options?): AxiosPromise<void>

  • 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: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Modify a VPC Private Endpoint

    Throws

• allowedIPAccessListCreate:function

  • allowedIPAccessListCreate(groupId, appId, allowedIPAccessListCreateRequest, options?): AxiosPromise<AllowedIPAccessListCreate201Response>

  • 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: any

      Override http request option.

    Returns AxiosPromise<AllowedIPAccessListCreate201Response>

    Summary

    Create an IP address or CIDR block in the Access List

    Throws

• allowedIPAccessListDelete:function

  • allowedIPAccessListDelete(groupId, appId, ipId, options?): AxiosPromise<void>

  • 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: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete an IP address or CIDR block from the Access List

    Throws

• allowedIPAccessListGet:function

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

  • 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: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List the allowed entries in the Access List

    Throws

• allowedIPAccessListUpdate:function

  • allowedIPAccessListUpdate(groupId, appId, ipId, allowedIPAccessListUpdateRequest, options?): AxiosPromise<AllowedIPAccessListCreate201Response>

  • 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: any

      Override http request option.

    Returns AxiosPromise<AllowedIPAccessListCreate201Response>

    Summary

    Modify an IP address or CIDR block in the Access List

    Throws