---
title: "Patch Organization"
method: PATCH
path: "/api/v1/entities/admin/organizations/{id}"
tags: ["Organization - Entity APIs"]
---

# Patch Organization

`PATCH /api/v1/entities/admin/organizations/{id}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/admin/organizations/{id}`
- Auth: none declared

## Path parameters

- `id` string, required

## Query parameters

- `filter` string
- `include` string[]

## Request body

- JsonApiOrganizationPatchDocument
  - `data` JsonApiOrganizationPatch, required: JSON:API representation of patching organization entity.
    - `attributes` object
      - `allowedOrigins` string[]
      - `earlyAccess` string, nullable: The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
      - `earlyAccessValues` string[], nullable: The early access feature identifiers. They are used to enable experimental features.
      - `hostname` string
      - `name` string, nullable
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `identityProvider` object
        - `data` JsonApiIdentityProviderToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'identityProvider', required
    - `type` 'organization', required: Object type

## Response `200`

Request successfully processed

- JsonApiOrganizationOutDocument
  - `data` JsonApiOrganizationOut, required: JSON:API representation of organization entity.
    - `attributes` object
      - `allowedOrigins` string[]
      - `cacheSettings` object
        - `cacheStrategy` 'DURABLE' | 'EPHEMERAL'
        - `extraCacheBudget` integer
      - `dataCenter` string, nullable: Current deployment region. Should be used for issue investigation only.
      - `earlyAccess` string, nullable: The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
      - `earlyAccessValues` string[], nullable: The early access feature identifiers. They are used to enable experimental features.
      - `hostname` string
      - `name` string, nullable
      - `region` string, nullable: Current deployment cluster name. Should be used for issue investigation only.
    - `id` string, required: API identifier of an object
    - `meta` object
      - `permissions` string[]: List of valid permissions for a logged-in user.
    - `relationships` object
      - `bootstrapUser` object
        - `data` JsonApiUserToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'user', required
      - `bootstrapUserGroup` object
        - `data` JsonApiUserGroupToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'userGroup', required
      - `identityProvider` object
        - `data` JsonApiIdentityProviderToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'identityProvider', required
    - `type` 'organization', required: Object type
  - `included` JsonApiOrganizationOutIncludes[]: Included resources
    - union
      - JsonApiIdentityProviderOutWithLinks: JSON:API representation of identityProvider entity.
        - `attributes` object
          - `customClaimMapping` object: Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
          - `identifiers` string[]: List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
          - `idpType` 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP': Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
          - `oauthClientId` string: The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
          - `oauthCustomAuthAttributes` object: Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
          - `oauthCustomScopes` string[], nullable: List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
          - `oauthIssuerId` string: Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
          - `oauthIssuerLocation` string: The location of your OIDC provider. This field is mandatory for OIDC IdP.
          - `oauthSubjectIdClaim` string: Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.
        - `id` string, required: API identifier of an object
        - `type` 'identityProvider', required: Object type
        - `links` ObjectLinks
          - `self` string, uri, required: A string containing the link's URL.
      - JsonApiUserOutWithLinks: JSON:API representation of user entity.
        - `attributes` object
          - `authenticationId` string
          - `email` string
          - `firstname` string
          - `lastname` string
          - `systemAccount` boolean: Is user system account
        - `id` string, required: API identifier of an object
        - `relationships` object
          - `userGroups` object
            - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
              - …
        - `type` 'user', required: Object type
        - `links` ObjectLinks
          - `self` string, uri, required: A string containing the link's URL.
      - JsonApiUserGroupOutWithLinks: JSON:API representation of userGroup entity.
        - `attributes` object
          - `name` string
        - `id` string, required: API identifier of an object
        - `relationships` object
          - `parents` object
            - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
              - …
        - `type` 'userGroup', required: Object type
        - `links` ObjectLinks
          - `self` string, uri, required: A string containing the link's URL.
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.
  - `meta` object
    - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
      - `id` string, required: Object identifier, unique within one workspace hierarchy.
      - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)