Microsoft Graph Organizations
Microsoft Graph Organizations exposes a tenant’s organization profile in Microsoft Entra ID (formerly Azure Active Directory) so apps can discover and manage directory‑level information through a single API.
OpenAPI Specification
openapi: 3.1.0
info:
title: Microsoft Graph Organization
description: Needs a description.
paths:
/organization:
description: Provides operations to manage the collection of organization entities.
get:
tags:
- Organization.organization
summary: Microsoft Graph List organizations
description: >-
Retrieve a list of organization objects. There's only one organization
object in the collection.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organization-list?view=graph-rest-1.0
operationId: organization.organization.ListOrganization
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.organizationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Organization.organization
summary: Microsoft Graph Add new entity to organization
operationId: organization.organization.CreateOrganization
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/organization/{organization-id}:
description: Provides operations to manage the collection of organization entities.
get:
tags:
- Organization.organization
summary: Microsoft Graph Get organization
description: >-
Get the properties and relationships of the currently authenticated
organization. Since the organization resource supports extensions, you
can also use the GET operation to get custom properties and extension
data in an organization instance.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organization-get?view=graph-rest-1.0
operationId: organization.organization.GetOrganization
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Organization.organization
summary: Microsoft Graph Update organization
description: >-
Update the properties of the currently authenticated organization. In
this case, organization is defined as a collection of exactly one
record, and so its ID must be specified in the request. The ID is also
known as the tenantId of the organization.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organization-update?view=graph-rest-1.0
operationId: organization.organization.UpdateOrganization
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organization'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Organization.organization
summary: Microsoft Graph Delete entity from organization
operationId: organization.organization.DeleteOrganization
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding:
description: >-
Provides operations to manage the branding property of the
microsoft.graph.organization entity.
get:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Get organizationalBranding
description: >-
Retrieve the default organizational branding object, if the
Accept-Language header is set to 0 or default. If no default
organizational branding object exists, this method returns a 404 Not
Found error. If the Accept-Language header is set to an existing locale
identified by the value of its id, this method retrieves the branding
for the specified locale. This method retrieves only non-Stream
properties, for example, usernameHintText and signInPageText. To
retrieve Stream types of the default branding, for example, bannerLogo
and backgroundImage, use the GET organizationalBrandingLocalization
method.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organizationalbranding-get?view=graph-rest-1.0
operationId: organization.GetBranding
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organizationalBranding'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Update organizationalBranding
description: >-
Update the properties of the default branding object specified by the
organizationalBranding resource.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organizationalbranding-update?view=graph-rest-1.0
operationId: organization.UpdateBranding
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organizationalBranding'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.organizationalBranding'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Delete organizationalBranding
description: >-
Delete the default organizational branding object. To delete the
organizationalBranding object, all images (Stream types) must first be
removed from the object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organizationalbranding-delete?view=graph-rest-1.0
operationId: organization.DeleteBranding
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding/backgroundImage:
description: Provides operations to manage the media for the organization entity.
get:
tags:
- organization.organizationalBranding
summary: >-
Microsoft Graph Get backgroundImage for the navigation property branding from organization
description: >-
Image that appears as the background of the sign-in page. The allowed
types are PNG or JPEG not smaller than 300 KB and not larger than 1920 ×
1080 pixels. A smaller image reduces bandwidth requirements and make the
page load faster.
operationId: organization.GetBrandingBackgroundImage
responses:
2XX:
description: Retrieved media content
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- organization.organizationalBranding
summary: >-
Microsoft Graph Update backgroundImage for the navigation property branding in organization
description: >-
Image that appears as the background of the sign-in page. The allowed
types are PNG or JPEG not smaller than 300 KB and not larger than 1920 ×
1080 pixels. A smaller image reduces bandwidth requirements and make the
page load faster.
operationId: organization.UpdateBrandingBackgroundImage
requestBody:
description: New media content.
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- organization.organizationalBranding
summary: >-
Microsoft Graph Delete backgroundImage for the navigation property branding in organization
description: >-
Image that appears as the background of the sign-in page. The allowed
types are PNG or JPEG not smaller than 300 KB and not larger than 1920 ×
1080 pixels. A smaller image reduces bandwidth requirements and make the
page load faster.
operationId: organization.DeleteBrandingBackgroundImage
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding/bannerLogo:
description: Provides operations to manage the media for the organization entity.
get:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Get bannerLogo for the navigation property branding from organization
description: >-
A banner version of your company logo that appears on the sign-in page.
The allowed types are PNG or JPEG not larger than 36 × 245 pixels. We
recommend using a transparent image with no padding around the logo.
operationId: organization.GetBrandingBannerLogo
responses:
2XX:
description: Retrieved media content
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Update bannerLogo for the navigation property branding in organization
description: >-
A banner version of your company logo that appears on the sign-in page.
The allowed types are PNG or JPEG not larger than 36 × 245 pixels. We
recommend using a transparent image with no padding around the logo.
operationId: organization.UpdateBrandingBannerLogo
requestBody:
description: New media content.
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Delete bannerLogo for the navigation property branding in organization
description: >-
A banner version of your company logo that appears on the sign-in page.
The allowed types are PNG or JPEG not larger than 36 × 245 pixels. We
recommend using a transparent image with no padding around the logo.
operationId: organization.DeleteBrandingBannerLogo
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding/customCSS:
description: Provides operations to manage the media for the organization entity.
get:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Get customCSS for the navigation property branding from organization
description: >-
CSS styling that appears on the sign-in page. The allowed format is .css
format only and not larger than 25 KB.
operationId: organization.GetBrandingCustomCSS
responses:
2XX:
description: Retrieved media content
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Update customCSS for the navigation property branding in organization
description: >-
CSS styling that appears on the sign-in page. The allowed format is .css
format only and not larger than 25 KB.
operationId: organization.UpdateBrandingCustomCSS
requestBody:
description: New media content.
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Delete customCSS for the navigation property branding in organization
description: >-
CSS styling that appears on the sign-in page. The allowed format is .css
format only and not larger than 25 KB.
operationId: organization.DeleteBrandingCustomCSS
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding/favicon:
description: Provides operations to manage the media for the organization entity.
get:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Get favicon for the navigation property branding from organization
description: >-
A custom icon (favicon) to replace a default Microsoft product favicon
on a Microsoft Entra tenant.
operationId: organization.GetBrandingFavicon
responses:
2XX:
description: Retrieved media content
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Update favicon for the navigation property branding in organization
description: >-
A custom icon (favicon) to replace a default Microsoft product favicon
on a Microsoft Entra tenant.
operationId: organization.UpdateBrandingFavicon
requestBody:
description: New media content.
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Delete favicon for the navigation property branding in organization
description: >-
A custom icon (favicon) to replace a default Microsoft product favicon
on a Microsoft Entra tenant.
operationId: organization.DeleteBrandingFavicon
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding/headerLogo:
description: Provides operations to manage the media for the organization entity.
get:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Get headerLogo for the navigation property branding from organization
description: >-
A company logo that appears in the header of the sign-in page. The
allowed types are PNG or JPEG not larger than 36 × 245 pixels. We
recommend using a transparent image with no padding around the logo.
operationId: organization.GetBrandingHeaderLogo
responses:
2XX:
description: Retrieved media content
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Update headerLogo for the navigation property branding in organization
description: >-
A company logo that appears in the header of the sign-in page. The
allowed types are PNG or JPEG not larger than 36 × 245 pixels. We
recommend using a transparent image with no padding around the logo.
operationId: organization.UpdateBrandingHeaderLogo
requestBody:
description: New media content.
content:
image/bmp:
schema:
type: string
format: binary
image/jpg:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/gif:
schema:
type: string
format: binary
image/vnd.microsoft.icon:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- organization.organizationalBranding
summary: Microsoft Graph Delete headerLogo for the navigation property branding in organization
description: >-
A company logo that appears in the header of the sign-in page. The
allowed types are PNG or JPEG not larger than 36 × 245 pixels. We
recommend using a transparent image with no padding around the logo.
operationId: organization.DeleteBrandingHeaderLogo
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
schema:
type: string
x-ms-docs-key-type: organization
/organization/{organization-id}/branding/localizations:
description: >-
Provides operations to manage the localizations property of the
microsoft.graph.organizationalBranding entity.
get:
tags:
- organization.organizationalBranding
summary: Microsoft Graph List localizations
description: >-
Retrieve all localization branding objects, including the default
branding.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/organizationalbranding-list-localizations?view=graph-rest-1.0
operationId: organization.branding.ListLocalizations
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.organizationalBrandingLocalizationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
# --- truncated at 32 KB (130 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/organization-openapi-original.yml