Members

List all members for a team

get

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

teamIdstringRequired

The id of the team

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 team members

application/json

totalResultsintegerRequired

offsetintegerRequired

limitintegerRequired

default

An error occurred

application/json

get/v1/identity/organizations/{organizationId}/teams/{teamId}/members

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

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

Create a team member

post

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

teamIdstringRequired

The id of the team

Body

userIdstringRequired

rolestring · enumRequiredPossible values:

Responses

200

Expected response to a valid request

application/json

idstringRequired

userIdstringOptional

rolestring · enumRequiredPossible values:

createdAtstringRequired

default

An error occurred

application/json

post/v1/identity/organizations/{organizationId}/teams/{teamId}/members

POST /v1/identity/organizations/{organizationId}/teams/{teamId}/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"
}

Delete a team member

delete

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

teamIdstringRequired

The id of the team

memberIdstringRequired

The id of the member

Responses

204

Team member deleted

No content

default

An error occurred

application/json

delete/v1/identity/organizations/{organizationId}/teams/{teamId}/members/{memberId}

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

No content