Skip to main content

Update organization​

Update organization by ID

Path Parameters
    id string required
Request Body required
    name string required

    The name of the organization. The name must be unique within the entire Frontier instance. The name can contain only alphanumeric characters, dashes and underscores.
    Example:"frontier-org1-acme"

    title string

    The title can contain any UTF-8 character, used to provide a human-readable name for the organization. Can also be left empty.
    Example: "Acme Inc"

    metadata object

    Metadata object for organizations that can hold key value pairs defined in Organization Metaschema. The metadata object can be used to store arbitrary information about the organization such as labels, descriptions etc. The default Organization Metaschema contains labels and descripton fields. Update the Organization Metaschema to add more fields.
    Example:{"labels": {"key": "value"}, "description": "Organization description"}

    avatar string

    The avatar is base64 encoded image data of the user. Can also be left empty. The image should be less than 200KB. Should follow the regex pattern ^data:image/(png|jpg|jpeg|gif);base64,([a-zA-Z0-9+/]+={0,2})+$.

Responses

A successful response.

Schema
    organization object
    id string
    name string
    title string
    metadata object
    createdAt date-time

    The time the organization was created.

    updatedAt date-time

    The time the organization was last updated.

    state string

    The state of the organization (enabled or disabled).

    avatar string

    The base64 encoded image string of the organization avatar. Should be less than 2MB.

PUT /v1beta1/organizations/:id

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
id — path required
Body required
{

  "name": "string",

  "title": "string",

  "metadata": {},

  "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAA"

}
curl / cURL
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "title": "string",
  "metadata": {},
  "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAA"
}'