Update an organization partially in NetApp Console local deployment

08/10/2026

PATCH /organizations/{organization_id}

Updates the specified organization with partial information. With content-type "application/vnd.netapp.bxp.resource+json", replaces the specified attributes in the request body with the values provided. With content-type "application/vnd.netapp.bxp.organization+json", allows the changing of specific settings for this organization. With content-type "application/vnd.netapp.bxp.organization+deactivation+json", performs an organization state change (deactivation or reactivation). The stateDesired field determines the action.

Parameters

Name	Type	In	Required	Description
organization_id	string	path	True	Organization ID. example: 666a3f38-d4fa-5b62-a391-a69029758d32
Accept	string	header	False	Specifies the expected response media type for state change operations. Must match the operation being performed: application/vnd.netapp.bxp.organization+deactivation+json for deactivation application/vnd.netapp.bxp.organization+deactivation+dryrun+json for deactivation dry-run application/vnd.netapp.bxp.organization+reactivation+json for reactivation application/vnd.netapp.bxp.organization+reactivation+dryrun+json for reactivation dry-run

Name

Type

Required

Description

organization_id

string

path

True

Organization ID.

example: 666a3f38-d4fa-5b62-a391-a69029758d32

string

header

False

Specifies the expected response media type for state change operations. Must match the operation being performed:

application/vnd.netapp.bxp.organization+deactivation+json for deactivation
application/vnd.netapp.bxp.organization+deactivation+dryrun+json for deactivation dry-run
application/vnd.netapp.bxp.organization+reactivation+json for reactivation
application/vnd.netapp.bxp.organization+reactivation+dryrun+json for reactivation dry-run

Request Body

With content-type "application/vnd.netapp.bxp.resource+json", replaces the specified attributes in the request body with the values provided. With content-type "application/vnd.netapp.bxp.organization+json", allows the changing of specific settings for this organization. With content-type "application/vnd.netapp.bxp.organization+deactivation+json", performs a state change operation (requires M2M token with tenancy:v4:sre scope). The stateDesired field determines the operation: DEACTIVATE, DEACTIVATE_DRYRUN, REACTIVATE, or REACTIVATE_DRYRUN.

Name	Type	Required	Description
orgAdminAuth0Id	string	False	Auth0 subject (e.g. auth0\|abc123) of the user to assign as organization admin upon reactivation.
orgAdminEmailId	string	False	Email address of the user to assign as organization admin upon reactivation.
orgAdminUserId	string	False	Internal user ID to assign as organization admin upon reactivation. At most one of orgAdminUserId, orgAdminAuth0Id, or orgAdminEmailId can be provided.
stateDesired	string	True	The desired reactivation operation: REACTIVATE: Reactivates a previously deactivated organization. REACTIVATE_DRYRUN: Previews what would be restored without making changes.

Name

Type

Required

Description

orgAdminAuth0Id

string

False

Auth0 subject (e.g. auth0|abc123) of the user to assign as organization admin upon reactivation.

orgAdminEmailId

string

False

Email address of the user to assign as organization admin upon reactivation.

orgAdminUserId

string

False

Internal user ID to assign as organization admin upon reactivation. At most one of orgAdminUserId, orgAdminAuth0Id, or orgAdminEmailId can be provided.

stateDesired

string

True

The desired reactivation operation:

REACTIVATE: Reactivates a previously deactivated organization.
REACTIVATE_DRYRUN: Previews what would be restored without making changes.

Example request

{
  "stateDesired": "DEACTIVATE"
}

Response

Status: 200, Returns the result of a state change operation (deactivation/reactivation). The response Content-Type matches the operation performed.

Name	Type	Required	Description
archived	archived	False	Counts of archived entities. Present when dryRun=false.
blockers	array[string]	False	List of conditions that block deactivation.
deactivationBatchId	string	False	Unique identifier linking all archived documents from this deactivation event. Only present when dryRun=false.
deactivationTimestamp	string	False	Timestamp of when the deactivation was performed. Only present when dryRun=false.
dryRun	boolean	False	Indicates whether this was a dry-run (preview) or actual deactivation.
excluded	excluded	False	Counts of entities excluded from archival. Present when dryRun=false.
impact	impact	False	Detailed impact report with counts and IDs of affected objects. Present when dryRun=true.
organizationId	string	False	ID of the organization that was deactivated.
status	string	False	Status of the organization. DEACTIVATED after successful deactivation, ACTIVE for dry-run previews (organization is still active).
ttlExpirationTimestamp	string	False	Timestamp of when archived data will be purged by TTL. Only present when dryRun=false.
users	users	False	Summary of user actions taken. Present when dryRun=false.
warnings	array[string]	False	List of warnings about the deactivation impact.

Name

Type

Required

Description

archived

False

Counts of archived entities. Present when dryRun=false.

blockers

array[string]

False

List of conditions that block deactivation.

deactivationBatchId

string

False

Unique identifier linking all archived documents from this deactivation event. Only present when dryRun=false.

deactivationTimestamp

string

False

Timestamp of when the deactivation was performed. Only present when dryRun=false.

dryRun

boolean

False

Indicates whether this was a dry-run (preview) or actual deactivation.

excluded

False

Counts of entities excluded from archival. Present when dryRun=false.

impact

False

Detailed impact report with counts and IDs of affected objects. Present when dryRun=true.

organizationId

string

False

ID of the organization that was deactivated.

status

string

False

Status of the organization. DEACTIVATED after successful deactivation, ACTIVE for dry-run previews (organization is still active).

ttlExpirationTimestamp

string

False

Timestamp of when archived data will be purged by TTL. Only present when dryRun=false.

users

False

Summary of user actions taken. Present when dryRun=false.

warnings

array[string]

False

List of warnings about the deactivation impact.

Example response

{
  "blockers": [
    "string"
  ],
  "deactivationBatchId": "string",
  "deactivationTimestamp": "string",
  "impact": {
    "bindings": {
      "ids": [
        "string"
      ]
    },
    "grants": {
      "ids": [
        "string"
      ]
    },
    "inactiveBindings": {
      "ids": [
        "string"
      ]
    },
    "inactiveGrants": {
      "ids": [
        "string"
      ]
    },
    "partnerships": {
      "dissolved": {
        "ids": [
          "string"
        ]
      }
    },
    "resourcegroups": {
      "ids": [
        "string"
      ]
    },
    "resources": {
      "ids": [
        "string"
      ]
    },
    "usergroups": {
      "ids": [
        "string"
      ]
    },
    "users": {
      "agents": {
        "ids": [
          "string"
        ]
      },
      "multiOrganizationUsers": {
        "action": "string",
        "ids": [
          "string"
        ]
      },
      "serviceAccounts": {
        "ids": [
          "string"
        ]
      },
      "soleOrganizationUsers": {
        "action": "string",
        "ids": [
          "string"
        ]
      },
      "systemUsersExcluded": {
        "ids": [
          "string"
        ]
      },
      "tagOnlyUsers": {
        "action": "string",
        "ids": [
          "string"
        ]
      }
    }
  },
  "organizationId": "string",
  "status": "string",
  "ttlExpirationTimestamp": "string",
  "warnings": [
    "string"
  ]
}

Response

Status: 204, Indicates if the organization was updated (for resource/safemode patches).

Response

Status: 406, The accept header does not match the expected response type for the statedesired operation.

Name	Type	Required	Description
error	string	False	Explanation of why the Accept header was rejected.

Name

Type

Required

Description

error

string

False

Explanation of why the Accept header was rejected.

Example response

{
  "error": "string"
}

Response

Status: 415, The content-type header is not recognized or supported for this endpoint.

Name	Type	Required	Description
error	string	False	Explanation of the unsupported media type.

Name

Type

Required

Description

error

string

False

Explanation of the unsupported media type.

Example response

{
  "error": "string"
}

Error

Status: 400, Bad request

Name	Type	Required	Description
correlationId	string	False	Internal UUID representing the request or trace ID related.
detail	string	False	Details about the problem.
invalidParams	array[invalidParams]	False	List of invalid parameters.
status	string	True	HTTP error code related to the problem.
title	string	True	Title description of the problem.
type	string	True	Content-type of the object.

Name

Type

Required

Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Example error response

{
  "detail": "The supplied query parameters are invalid.",
  "status": "400",
  "title": "Invalid query parameters",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 401, Unauthorized

Name	Type	Required	Description
correlationId	string	False	Internal UUID representing the request or trace ID related.
detail	string	False	Details about the problem.
invalidParams	array[invalidParams]	False	List of invalid parameters.
status	string	True	HTTP error code related to the problem.
title	string	True	Title description of the problem.
type	string	True	Content-type of the object.

Name

Type

Required

Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Example error response

{
  "detail": "The request is missing the required bearer token.",
  "status": "401",
  "title": "Missing bearer token",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 403, Forbidden

Name	Type	Required	Description
correlationId	string	False	Internal UUID representing the request or trace ID related.
detail	string	False	Details about the problem.
invalidParams	array[invalidParams]	False	List of invalid parameters.
status	string	True	HTTP error code related to the problem.
title	string	True	Title description of the problem.
type	string	True	Content-type of the object.

Name

Type

Required

Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Example error response

{
  "detail": "The requested operation isn't permitted.",
  "status": "403",
  "title": "Operation not permitted",
  "type": "https://bluexp.netapp.io/problems/11"
}

Error

Status: 404, Not found

Name	Type	Required	Description
correlationId	string	False	Internal UUID representing the request or trace ID related.
detail	string	False	Details about the problem.
invalidParams	array[invalidParams]	False	List of invalid parameters.
status	string	True	HTTP error code related to the problem.
title	string	True	Title description of the problem.
type	string	True	Content-type of the object.

Name

Type

Required

Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Example error response

{
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404",
  "title": "Collection not found",
  "type": "https://bluexp.netapp.io/problems/2"
}

Error

Status: 409, Conflict

Name	Type	Required	Description
correlationId	string	False	Internal UUID representing the request or trace ID related.
detail	string	False	Details about the problem.
invalidParams	array[invalidParams]	False	List of invalid parameters.
status	string	True	HTTP error code related to the problem.
title	string	True	Title description of the problem.
type	string	True	Content-type of the object.

Name

Type

Required

Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Example error response

{
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409",
  "title": "JSON resource conflict",
  "type": "https://bluexp.netapp.io/problems/10"
}

Definitions

See Definitions

archived

Counts of archived entities. Present when dryRun=false.

Name	Type	Required	Description
bindings	integer	False
elevatedBindingsDeleted	integer	False	Number of elevated (safe-mode TTL) bindings deleted prior to archival.
grants	integer	False
inactiveBindings	integer	False
inactiveGrants	integer	False
resourcegroups	integer	False
resources	integer	False
usergroups	integer	False

Name

Type

Required

Description

bindings

integer

False

elevatedBindingsDeleted

integer

False

Number of elevated (safe-mode TTL) bindings deleted prior to archival.

grants

integer

False

inactiveBindings

integer

False

inactiveGrants

integer

False

resourcegroups

integer

False

resources

integer

False

usergroups

integer

False

excluded

Counts of entities excluded from archival. Present when dryRun=false.

Name	Type	Required	Description
systemUsers	integer	False

Name

Type

Required

Description

systemUsers

integer

False

deactivation_impact_detail

Name	Type	Required	Description
count	integer	False	Number of affected entities.
ids	array[string]	False	List of affected entity IDs.

Name

Type

Required

Description

count

integer

False

Number of affected entities.

ids

array[string]

False

List of affected entity IDs.

partnerships

Name	Type	Required	Description
dissolved	deactivation_impact_detail	False

Name

Type

Required

Description

dissolved

deactivation_impact_detail

False

deactivation_user_impact

Name	Type	Required	Description
action	string	False	Description of the action taken on these users.
count	integer	False	Number of affected users.
ids	array[string]	False	List of affected user IDs.

Name

Type

Required

Description

action

string

False

Description of the action taken on these users.

count

integer

False

Number of affected users.

ids

array[string]

False

List of affected user IDs.

users

Name	Type	Required
agents	deactivation_impact_detail	False
multiOrganizationUsers	deactivation_user_impact	False
serviceAccounts	deactivation_impact_detail	False
soleOrganizationUsers	deactivation_user_impact	False
systemUsersExcluded	deactivation_impact_detail	False
tagOnlyUsers	deactivation_user_impact	False

Name

Type

Required

Description

agents

deactivation_impact_detail

False

multiOrganizationUsers

deactivation_user_impact

False

serviceAccounts

deactivation_impact_detail

False

soleOrganizationUsers

deactivation_user_impact

False

systemUsersExcluded

deactivation_impact_detail

False

tagOnlyUsers

deactivation_user_impact

False

impact

Detailed impact report with counts and IDs of affected objects. Present when dryRun=true.

Name	Type	Required
bindings	deactivation_impact_detail	False
grants	deactivation_impact_detail	False
inactiveBindings	deactivation_impact_detail	False
inactiveGrants	deactivation_impact_detail	False
partnerships	partnerships	False
resourcegroups	deactivation_impact_detail	False
resources	deactivation_impact_detail	False
usergroups	deactivation_impact_detail	False
users	users	False

Name

Type

Required

Description

bindings

deactivation_impact_detail

False

grants

deactivation_impact_detail

False

inactiveBindings

deactivation_impact_detail

False

inactiveGrants

deactivation_impact_detail

False

partnerships

False

resourcegroups

deactivation_impact_detail

False

resources

deactivation_impact_detail

False

usergroups

deactivation_impact_detail

False

users

False

users

Summary of user actions taken. Present when dryRun=false.

Name	Type	Required
deleted	integer	False
organizationAssociationRemoved	integer	False
tagsRemoved	integer	False

Name

Type

Required

Description

deleted

integer

False

organizationAssociationRemoved

integer

False

tagsRemoved

integer

False

invalidParams

Name	Type	Required	Description
name	string	True	Name of the invalid parameter.
reason	string	True	Reason why the parameter is invalid.

Name

Type

Required

Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.