---
title: "POST /environment"
method: POST
path: "/environment"
---

# POST /environment

`POST /environment`

Create a new FinSpace environment.

## Request body

- object
  - `name` string, required — The name of the FinSpace environment to be created.
  - `description` string — The description of the FinSpace environment to be created.
  - `kmsKeyId` string — The KMS key id to encrypt your data in the FinSpace environment.
  - `tags` object — Add tags to your FinSpace environment.
  - `federationMode` 'FEDERATED' | 'LOCAL' — <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>
  - `federationParameters` object — Configuration information when authentication mode is FEDERATED.
    - `samlMetadataDocument` string — SAML 2.0 Metadata document from identity provider (IdP).
    - `samlMetadataURL` string — Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
    - `applicationCallBackURL` string — The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
    - `federationURN` string — The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
    - `federationProviderName` string — Name of the identity provider (IdP).
    - `attributeMap` object — SAML attribute name and value. The name must always be <code>Email</code> and the value should be set to the attribute definition in which user email is set. For example, name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
  - `superuserParameters` object — Configuration information for the superuser.
    - `emailAddress` string, password — The email address of the superuser.
    - `firstName` string — The first name of the superuser.
    - `lastName` string — The last name of the superuser.
  - `dataBundles` DataBundleArn[] — <p>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</p> <ul> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p> </li> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p> </li> </ul>

## Response `200`

Success

- CreateEnvironmentResponse
  - `environmentId` string — The unique identifier for FinSpace environment that you created.
  - `environmentArn` string — The Amazon Resource Name (ARN) of the FinSpace environment that you created.
  - `environmentUrl` string — The sign-in url for the web application of the FinSpace environment you created.

## Other responses

- `480` — InternalServerException
- `481` — ValidationException
- `482` — AccessDeniedException
- `483` — ThrottlingException
- `484` — ServiceQuotaExceededException
- `485` — LimitExceededException

---

[API](https://skmtc.net/aws/apis/finspace.md) · [All operations](https://skmtc.net/aws/apis/finspace/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/finspace/versions/2e1da9b20d1e/schema)