> ## Documentation Index
> Fetch the complete documentation index at: https://tyk.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Update an organisation
> Update an organisation's data. At this point, you can change only the name of an organisation
## OpenAPI
````yaml /swagger/nightly/enterprise-developer-portal-swagger.yaml put /organisations/{organisation_id}
openapi: 3.1.0
info:
title: Tyk Developer Portal
description: >-
## Introduction
The Tyk Enterprise Developer Portal Management API offers programmatic
access to all portal resources that your instance of the portal manages.
This API repeats functionality of the user interface and enables APIs
consumers integrating their portal instances with their other IT systems
such as billings, CRMs, ITSM systems and other software.
## Authentication
This API requires an admin authorisation token that is available for admin
users of the portal in the profile page.
version: 1.14.0
servers:
- url: http://localhost:3001/portal-api
security: []
tags:
- name: Providers
description: API Providers connected to this portal instance
- name: Users
description: Portal admins and API consumers
- name: Organisations
description: Organisation of API consumers and the portal admins
- name: Teams
description: Teams of API consumers and the portal admins
- name: Products
description: >-
Marketing description and visibility of the API Products surfaced in this
portal instance
- name: Tutorials for API Products
description: Tutorials that are defined for the API products
- name: API documentation for API Products
description: OpenAPI specs for APIs included into the API Prodcuts
- name: Plans
description: >-
Marketing description and visibility settings of usage plans defined in
this portal instance
- name: Catalogues
description: Catalogues of API Products listed on this portal instance
- name: Catalogue audiences
description: Audience management
- name: Access requests
description: Access requests to API Products
- name: Applications and credentials
description: Developer applications and API credential for developers
- name: Portal configuration
description: Show the current portal configuration
- name: Pages and content
description: Pages and content on the pages
- name: Themes
description: Management of the portal's visual themes
- name: Custom Attributes
description: Extend already existing models (User) by adding custom attributes
- name: OAuth2.0 providers
description: OAuth2.0 providers registered in the portal
- name: Webhooks
description: Webhooks management
- name: Posts
description: Posts management
- name: SSO Profiles
description: SSO Profiles management
- name: Tags
description: >-
Tags management: link API Products to blog posts and control their
display.
paths:
/organisations/{organisation_id}:
put:
tags:
- Organisations
summary: Update an organisation
description: >-
Update an organisation's data. At this point, you can change only the
name of an organisation
operationId: update-organisation
parameters:
- description: UID of an organisation
in: path
name: organisation_id
required: true
schema:
type: integer
example: 2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Organisation-create'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Organisation-show'
description: OK
security:
- AdminAPIToken: []
components:
schemas:
Organisation-create:
properties:
Name:
type: string
description: Name of an organisation
example: Default Organisation
type: object
Organisation-show:
properties:
CreatedAt:
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
description: Date-time when a user is created
example: 2023-06-23 21:02
type: string
UpdatedAt:
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
description: Date-time when a user is updated the last time
example: 2023-06-23 21:02
type: string
ID:
type: integer
description: UID of an organisation
example: 1
Name:
type: string
description: Name of an organisation
example: Default Organisation
Teams:
items:
$ref: '#/components/schemas/Team-index-elem'
type: array
description: Teams included in this organisation
Users:
type: array
description: >-
Users that are included in this organisation. For newly created
organisation this field will be an empty array
items:
$ref: '#/components/schemas/User-index-elem'
type: object
Team-index-elem:
properties:
Default:
type: boolean
description: >-
Identifies if this team is a default team for this organisation. All
new users are created in the default team unless otherwise
specified.
example: true
ID:
type: integer
description: UID of this team
example: 1
Name:
type: string
description: Name of this team
example: Default Organisation All users
type: object
User-index-elem:
allOf:
- $ref: '#/components/schemas/User-basis'
- type: object
properties:
ID:
type: integer
description: UID of a user
example: 1
User-basis:
type: object
properties:
Active:
description: Defines if this user is active and can login to the portal
type: boolean
example: true
Email:
description: Email of a user
type: string
example: admin@acme.com
First:
type: string
description: First name of a user
example: John
Last:
type: string
description: Last name of a user
example: Doe
OrganisationID:
type: integer
description: >-
ID of an organisation where this user belongs to. For admin users it
is always equal to 0
example: 1
Role:
type: string
description: Role of a user in their organisation
example: consumer-team-member
Provider:
type: string
description: Type of identity provider for this user, e.g. password, github, etc.
example: password
securitySchemes:
AdminAPIToken:
type: apiKey
in: header
name: Authorization
````