Organizations

List all organizations

get

Query parameters

offsetinteger · int32Optional

The offset into queried items to return

limitinteger · int32 · max: 100Optional

How many items to return at one time (max 100)

Responses

200

A paged array of organizations

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/identity/organizations HTTP/1.1
Host: localhost:3050
Accept: */*

{
  "organizations": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      },
      "createdAt": "text"
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create an organisation

post

Body

application/json

namestringRequired

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

HTTPcURLJavaScriptPython

POST /v1/identity/organizations HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  },
  "createdAt": "text"
}

Info for a specific organization

get

Path parameters

organizationIdstringRequired

The id of the organization to retrieve

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/identity/organizations/{organizationId} HTTP/1.1
Host: localhost:3050
Accept: */*

{
  "organization": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdBy": {
      "userId": "text",
      "type": "user"
    },
    "createdAt": "text"
  },
  "organizationMembership": {
    "role": "admin"
  }
}

Edit an organization

post

Path parameters

organizationIdstringRequired

The id of the organization to edit

Body

application/json

namestringRequired

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

HTTPcURLJavaScriptPython

POST /v1/identity/organizations/{organizationId} HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  },
  "createdAt": "text"
}