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

# GET /environment

`GET /environment`

A list of all of your FinSpace environments.

## Query parameters

- `nextToken` string
- `maxResults` integer

## Response `200`

Success

- ListEnvironmentsResponse
  - `environments` Environment[] — A list of all of your FinSpace environments.
    - `name` string — The name of the FinSpace environment.
    - `environmentId` string — The identifier of the FinSpace environment.
    - `awsAccountId` string — The ID of the AWS account in which the FinSpace environment is created.
    - `status` 'CREATE_REQUESTED' | 'CREATING' | 'CREATED' | 'DELETE_REQUESTED' | 'DELETING' | 'DELETED' | 'FAILED_CREATION' | 'RETRY_DELETION' | 'FAILED_DELETION' | 'SUSPENDED' — The current status of creation of the FinSpace environment.
    - `environmentUrl` string — The sign-in url for the web application of your FinSpace environment.
    - `description` string — The description of the FinSpace environment.
    - `environmentArn` string — The Amazon Resource Name (ARN) of your FinSpace environment.
    - `sageMakerStudioDomainUrl` string — The url of the integrated FinSpace notebook environment in your web application.
    - `kmsKeyId` string — The KMS key id used to encrypt in the FinSpace environment.
    - `dedicatedServiceAccountId` string — The AWS account ID of the dedicated service account associated with your FinSpace environment.
    - `federationMode` 'FEDERATED' | 'LOCAL' — The authentication mode for the environment.
    - `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.
  - `nextToken` string — A token that you can use in a subsequent call to retrieve the next set of results.

## Other responses

- `480` — InternalServerException
- `481` — ValidationException

---

[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)