Members

List all members within an organization

get

Path parameters

organizationIdstringRequired

The id of the organization to find members within

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 members

application/json

default

An error occurred

application/json

get

/v1/identity/organizations/{organizationId}/members

HTTPcURLJavaScriptPython

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

{
  "members": [
    {
      "id": "text",
      "userId": "text",
      "userInfo": {
        "displayName": "text",
        "email": "text",
        "photoUrl": "text"
      },
      "role": "admin",
      "createdAt": "text"
    }
  ],
  "role": "admin",
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create a member

post

Path parameters

organizationIdstringRequired

The id of the organization to find members within

Body

application/json

userIdstringRequired

rolestring · enumRequiredPossible values:

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

/v1/identity/organizations/{organizationId}/members

HTTPcURLJavaScriptPython

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

{
  "userId": "text",
  "role": "admin"
}

{
  "id": "text",
  "userId": "text",
  "userInfo": {
    "displayName": "text",
    "email": "text",
    "photoUrl": "text"
  },
  "role": "admin",
  "createdAt": "text"
}

Get a member

get

Path parameters

organizationIdstringRequired

The id of the organization the member is within

memberIdstringRequired

The id of the member

Responses

200

A member

application/json

default

An error occurred

application/json

get

/v1/identity/organizations/{organizationId}/members/{memberId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "userId": "text",
  "userInfo": {
    "displayName": "text",
    "email": "text",
    "photoUrl": "text"
  },
  "role": "admin",
  "createdAt": "text"
}

Update a member

post

Path parameters

organizationIdstringRequired

The id of the organization the member is within

memberIdstringRequired

The id of the member

Body

application/json

rolestring · enumRequiredPossible values:

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

/v1/identity/organizations/{organizationId}/members/{memberId}

HTTPcURLJavaScriptPython

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

{
  "role": "admin"
}

{
  "id": "text",
  "userId": "text",
  "userInfo": {
    "displayName": "text",
    "email": "text",
    "photoUrl": "text"
  },
  "role": "admin",
  "createdAt": "text"
}

Delete a member

delete

Path parameters

organizationIdstringRequired

The id of the organization the member is within

memberIdstringRequired

The id of the member

Responses

204

Expected response to a valid request

default

An error occurred

application/json

delete

/v1/identity/organizations/{organizationId}/members/{memberId}

HTTPcURLJavaScriptPython

DELETE /v1/identity/organizations/{organizationId}/members/{memberId} HTTP/1.1
Host: localhost:3050
Accept: */*

No content