symphony.bdk.core.service.application.application_service.ApplicationService#

class symphony.bdk.core.service.application.application_service.ApplicationService(application_api: symphony.bdk.gen.pod_api.application_api.ApplicationApi, app_entitlement_api: symphony.bdk.gen.pod_api.app_entitlement_api.AppEntitlementApi, auth_session: symphony.bdk.core.auth.auth_session.AuthSession, retry_config: symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig)#

Bases: object

Service class for managing the applications and the application entitlements.

This services used for retrieving information about a particular application or application entitlements, performing some actions related to the applications like:

  • Create an application

  • Update an existing application

  • Delete an existing application

  • Get the information of an existing application

  • Update application entitlements

  • Update user applications

__init__(application_api: symphony.bdk.gen.pod_api.application_api.ApplicationApi, app_entitlement_api: symphony.bdk.gen.pod_api.app_entitlement_api.AppEntitlementApi, auth_session: symphony.bdk.core.auth.auth_session.AuthSession, retry_config: symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig)#

Methods

__init__(application_api, ...)

create_application(application_detail)

Create a new application.

delete_application(app_id)

Delete an existing application.

get_application(app_id)

Get an existing application.

list_application_entitlements()

Get the list of application entitlements for the company.

list_user_applications(user_id)

Get the list of Symphony application entitlements for a particular user.

patch_user_applications(user_id, ...)

Updates particular app entitlements for a particular user.

update_application(app_id, application_detail)

Update an existing application.

update_application_entitlements(entitlements)

Update the list of application entitlements for the company.

update_user_applications(user_id, ...)

Update the application entitlements for a particular user.

create_application(application_detail: symphony.bdk.gen.pod_model.application_detail.ApplicationDetail) symphony.bdk.gen.pod_model.application_detail.ApplicationDetail#

Create a new application.

See:

Parameters

application_detail – Contains the following fields for creating an application: appId, name, appUrl, domain, and publisher. Note that appUrl is not required.

Returns

The created application.

delete_application(app_id: str) None#

Delete an existing application.

See: Delete Application

Parameters

app_id – Id of the application needs to be deleted.

get_application(app_id: str) symphony.bdk.gen.pod_model.application_detail.ApplicationDetail#

Get an existing application.

See: Get Application

Parameters

app_id – Id of the application.

Returns

The detail of the lookup application.

list_application_entitlements()#

Get the list of application entitlements for the company.

See: List App Entitlements

Returns

The list of application entitlements.

list_user_applications()#

Get the list of Symphony application entitlements for a particular user.

See: User Apps

Parameters

user_id – User Id

Returns

The list of Symphony application entitlements for this user.

patch_user_applications()#

Updates particular app entitlements for a particular user. Supports partial update.

See: Update User Apps

Parameters
  • user_id – User Id

  • user_app_entitlements – The list of App Entitlements needs to be updated.

Returns

The updated list of Symphony application entitlements for this user.

update_application(app_id: str, application_detail: symphony.bdk.gen.pod_model.application_detail.ApplicationDetail) symphony.bdk.gen.pod_model.application_detail.ApplicationDetail#

Update an existing application.

See:

Parameters
  • app_id – Id of the application needs to be updated.

  • application_detail – Contains the following fields for creating an application: appId, name, appUrl, domain, and publisher. Note that appUrl is not required.

Returns

The updated application.

update_application_entitlements()#

Update the list of application entitlements for the company.

See: Update App Entitlements

Parameters

entitlements – The list of entitlements to be updated by.

Returns

The updated list of entitlements.

update_user_applications()#

Update the application entitlements for a particular user.

See: Update User Apps

Parameters
  • user_id – User Id

  • user_app_entitlements – The list of App Entitlements needs to be updated.

Returns

The updated list of Symphony application entitlements for this user.