/api/v1/organization-invitations
Requires the GV.APIOwner application role, or a higher role (Owner > Contributor > Reader).
Operation ID · create_organization_invitation
Request example
Authentication and access
- Required role: GV.APIOwner
- Data classification: metadata
- Side effects: configurationWrite
- Microsoft Entra delegated user token
- Microsoft Entra application token
Parameters
Idempotency-Key
header Required Required caller-chosen retry identity. Use 1-128 visible ASCII characters and reuse it only for an exact retry of this request.string
minimum length: 1 · maximum length: 128
Request body
Requiredapplication/json
Schema V1OrganizationInvitationCreateobject
Properties
email— Required
string
minimum length: 3 · maximum length: 320
expiresAt— Required
string (date-time)
role— Required
string
- Allowed values:
"reader","contributor","owner"
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 useapplication/problem+json. The response’s stable code and type map to the error-code reference.
201
Invitation metadata created. Delivery is fail-closed until an invitation provider is configured.Headers
- Idempotency-Replayed:
boolean - Location:
string
401
A valid Microsoft Entra bearer token is required.403
The authenticated principal does not have the required role.404
The resource does not exist in this tenant.409
The operation conflicts with current resource or Azure state.422
The request is syntactically valid but semantically invalid.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