> ## Documentation Index > Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update an Organization > Update an Organization's details. ## OpenAPI ````yaml /astro/api/v-1/openapi.yaml post /organizations/{organizationId} openapi: 3.0.3 info: contact: {} description: Astro Platform API title: Astro Platform API version: v1.0 servers: - url: https://api.astronomer.io/v1 security: - JWT: [] tags: - description: >- The `organization` object contains the metadata and configurations of an Astro Organization. It does not include objects within the Organization, such as users and clusters. Make requests to `organization` endpoints to view and update high level settings for your Organization, including settings related to authentication and billing. To manage resources within an Organization, make requests to the endpoints related to those resources, such as `users`. See [Billing](https://astronomer.io/docs/astro/manage-billing), [Set up single sign-on](https://astronomer.io/docs/astro/configure-idp), and [Manage domains](https://astronomer.io/docs/astro/manage-domains). name: Organization - description: >- The `deployment` object represents an Astro Deployment, which is a hosted Airflow environment that is powered by all core Airflow components, including schedulers and workers. Make requests to the `deployment` object to create, update, or delete a Deployment or its computational resources. See [Deployment settings](https://astronomer.io/docs/astro/deployment-settings). name: Deployment - description: >- A `cluster` object represents an Astro cluster, which is a Kubernetes cluster that hosts the infrastructure required to run Deployments. Make requests to `cluster` endpoints to manage your standard and dedicated clusters. See [Create a dedicated cluster](https://astronomer.io/docs/astro/create-dedicated-cluster). name: Cluster - description: >- The `workspace` object represents an Astro Workspace, which is a collection of Deployments that can be accessed by a specific group of users. It contains metadata about a Workspace, but does not contain objects within the Workspace such as users and Deployments. Make requests to `workspace` endpoints to manage high level details about your Workspace. To manage resources within a Workspace, make requests to the endpoints related to those resources, such as `users`, and use the `workspaceIds` parameter to filter results by Workspace. See [Configure Workspaces](https://astronomer.io/docs/astro/manage-workspaces). name: Workspace - description: >- The `user` object represents a user account in your Astro Organization. Astro creates a new `user` object whenever you invite a user by email or add a user to Astro through an identity provider. The object contains all information about a user, including their personal information, roles, and login attempts. It doesn't include attributes for actions that the user completes after they log in, such as updating a Deployment. Make requests to `user` endpoints to manage permissions for existing users both at the Organization and Workspace level. To create new users, make requests to `invite` endpoints instead. name: User - description: >- The `team` object represents an Astro Team, which is a group of users that share the same permissions across your Organization and Workspaces. Make requests to `team` endpoints to create, update, and delete Teams across an Organization. See [Configure Teams on Astro](https://astronomer.io/docs/astro/manage-teams). name: Team - description: >- The `apitoken` object represents a single API token within your Organization. API tokens are used to authenticate automated tools and processes to your Organization. They have varying levels of access to your resources based on their Organization, Workspace, and Deployment roles. See [Workspace API tokens](workspace-api-tokens.md) and [Organization API tokens](organization-api-tokens.md). name: api-token x-group: API Token - name: allowed-ip-address-range x-group: Allowed IP Address Range - name: agent-token x-group: Agent Token paths: /organizations/{organizationId}: post: tags: - Organization summary: Update an Organization description: Update an Organization's details. operationId: UpdateOrganization parameters: - description: The Organization's ID. in: path name: organizationId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrganizationRequest' description: The request body for updating the Organization. required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error security: - JWT: [] components: schemas: UpdateOrganizationRequest: properties: allowEnhancedSupportAccess: example: false type: boolean billingEmail: description: The Organization's billing email. example: billing@company.com type: string hasAiFeaturesDisabled: example: false type: boolean isScimEnabled: description: Whether SCIM is enabled for the Organization. example: false type: boolean name: description: The name of the Organization. example: My Organization maxLength: 50 type: string shouldEnforceDedicatedClusters: type: boolean required: - billingEmail - isScimEnabled - name type: object Organization: properties: allowEnhancedSupportAccess: description: >- Whether the organization allows CRE to have view access to their entities type: boolean billingEmail: description: The Organization's billing email. example: billing@company.com type: string createdAt: description: >- The time when the Organization was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string createdBy: $ref: '#/components/schemas/BasicSubjectProfile' hasAiFeaturesDisabled: type: boolean hasAllowedIpAddressRanges: description: >- Whether the Organization has at least one IP address range configured. example: false type: boolean id: description: The Organization's ID. example: clmaxoarx000008l2c5ayb9pt type: string isBlockedEnableAiFeatures: example: false type: boolean isScimEnabled: description: Whether SCIM is enabled for the Organization. example: false type: boolean managedDomains: description: The list of managed domains configured in the Organization. items: $ref: '#/components/schemas/ManagedDomain' type: array name: description: The Organization's name. example: My organization type: string paymentMethod: description: The Organization's payment method. enum: - CREDIT_CARD - INVOICE - AWS_MARKETPLACE - AZURE_MARKETPLACE - GCP_MARKETPLACE - SNOWFLAKE_MARKETPLACE example: CREDIT_CARD type: string product: description: The Organization's product type. enum: - HOSTED - HYBRID example: HOSTED type: string productPlans: items: $ref: '#/components/schemas/OrganizationProductPlan' type: array shouldEnforceDedicatedClusters: type: boolean status: description: The Organization's status. enum: - ACTIVE - INACTIVE - SUSPENDED example: ACTIVE type: string trialExpiresAt: description: >- The time when the Organization's trial expires in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. Organizations that are no longer in Trial will not have a expiry date. example: '2022-11-22T04:37:12Z' format: date-time type: string updatedAt: description: >- The time when the Organization was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string updatedBy: $ref: '#/components/schemas/BasicSubjectProfile' required: - allowEnhancedSupportAccess - createdAt - createdBy - hasAllowedIpAddressRanges - id - isBlockedEnableAiFeatures - isScimEnabled - name - productPlans - shouldEnforceDedicatedClusters - updatedAt - updatedBy type: object Error: properties: fieldErrors: description: >- FieldErrors carries one entry per failed request-validation constraint. Only present on 400 responses caused by request binding/validation. items: $ref: '#/components/schemas/FieldValidationError' type: array message: type: string requestId: type: string statusCode: maximum: 600 minimum: 400 type: integer required: - message - requestId - statusCode type: object BasicSubjectProfile: properties: apiTokenName: description: >- The API token's name. Returned only when `SubjectType` is `SERVICEKEY`. example: my-token type: string avatarUrl: description: >- The URL for the user's profile image. Returned only when `SubjectType` is `USER`. example: https://avatar.url type: string fullName: description: The subject's full name. Returned only when `SubjectType` is `USER`. example: Jane Doe type: string id: description: The subject's ID. example: clm8qv74h000008mlf08scq7k type: string subjectType: description: The subject type. enum: - USER - SERVICEKEY example: USER type: string username: description: The subject's username. Returned only when `SubjectType` is `USER`. example: user1@company.com type: string required: - id type: object ManagedDomain: properties: createdAt: description: >- The time when the domain was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. format: date-time type: string enforcedLogins: description: >- A list of login types that are enforced for users belonging to the domain. example: - password items: type: string type: array id: description: The managed domain's ID. example: cln203mz7000008jv0jyz9m3y type: string name: description: The managed domain's name/ URL. example: mycompany.com type: string organizationId: description: The ID of the Organization to which the managed domain belongs. example: cln204xr2000008mu3hhe3zwe type: string status: description: Whether the managed domain has completed the verification process. enum: - PENDING - VERIFIED type: string updatedAt: description: >- The time when the domain was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. format: date-time type: string required: - createdAt - id - name - organizationId - status - updatedAt type: object OrganizationProductPlan: properties: astronomerProduct: enum: - ASTRO type: string organizationId: type: string productPlanId: type: string productPlanName: enum: - INACTIVE - INTERNAL - POV - TRIAL - BASIC - BASIC_PAYGO - TEAM_PAYGO - STANDARD - PREMIUM - BUSINESS_CRITICAL - BUSINESS - TEAM - ENTERPRISE - DEVELOPER - DEVELOPER_PAYGO - TEAM_V2 - BUSINESS_V2 - ENTERPRISE_V2 - TRIAL_V2 - ENTERPRISE_BUSINESS_CRITICAL - IBM_ENTERPRISE example: BUSINESS_CRITICAL type: string required: - astronomerProduct - organizationId - productPlanId - productPlanName type: object FieldValidationError: properties: code: type: string field: type: string message: type: string required: - code - field - message type: object securitySchemes: JWT: scheme: bearer type: http ````