Skip to main content
API · Organization PATCH /api/v1/organization Requires the GV.APIOwner application role, or a higher role (Owner > Contributor > Reader). Operation ID · update_organization

Request example

Authentication and access

  • Required role: GV.APIOwner
  • Data classification: metadata
  • Side effects: configurationWrite
Use an authentication scheme declared below. Ordinary workloads use application tokens; signed-in users use delegated tokens and Organization membership. Activation and invitation acceptance require a person, and execution callbacks require their registered identity.
  • Microsoft Entra delegated user token
  • Microsoft Entra application token

Parameters

If-Match

header Required Exact strong ETag from the current resource. Weak validators, wildcards, and tag lists are rejected. string maximum length: 1024

Request body

Required

application/json

Schema V1OrganizationUpdate object Properties name— Required string minimum length: 1 · maximum length: 255 Additional properties are not allowed.

Responses

This guide summarizes response status codes and headers. Retrieve the deployed, authenticated OpenAPI document for the exact response body schemas and examples. The API also provides an authenticated Swagger UI; opening it in a browser does not automatically attach a bearer token. Error responses use application/problem+json. The response’s stable code and type map to the error-code reference.

200

Organization updated.

Headers

  • ETag: string

401

A valid Microsoft Entra bearer token is required.

403

The authenticated principal does not have the required role.

412

If-Match did not match the resource’s current strong ETag.

422

The request is syntactically valid but semantically invalid.

428

The exact current ETag is required in If-Match.

429

The bounded application request rate was exceeded.

Headers

  • Retry-After: Seconds to wait before retrying. integerminimum: 1

503

A required dependency is temporarily unavailable.

Headers

  • Retry-After: Seconds to wait before retrying. integerminimum: 1