Skip to content

UpdateEnvironmentRequest

Source code in docs_src/capo_finspace/types/update_environment_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
class UpdateEnvironmentRequest(TypedDict, closed=True):
    environment_id: "capo_finspace.types.id_type.IdType"
    """<p>The identifier of the FinSpace environment.</p>"""
    name: NotRequired["capo_finspace.types.environment_name.EnvironmentName"]
    """<p>The name of the environment.</p>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>The description of the environment.</p>"""
    federation_mode: NotRequired["capo_finspace.types.federation_mode.FederationMode"]
    """<p>Authentication mode for the environment.</p> <ul> <li> <p> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p> </li> <li> <p> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p> </li> </ul>"""
    federation_parameters: NotRequired[
        "capo_finspace.types.federation_parameters.FederationParameters"
    ]

description instance-attribute 

description: NotRequired[Description]

The description of the environment.

environment_id instance-attribute 

environment_id: IdType

The identifier of the FinSpace environment.

federation_mode instance-attribute 

federation_mode: NotRequired[FederationMode]

Authentication mode for the environment.

  • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

  • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

federation_parameters instance-attribute 

federation_parameters: NotRequired[FederationParameters]

name instance-attribute 

name: NotRequired[EnvironmentName]

The name of the environment.