Teams

List all teams within an organization

get

Path parameters

organizationIdstringRequired

The id of the organization to find teams 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 teams

application/json

totalResultsintegerRequired

offsetintegerRequired

limitintegerRequired

default

An error occurred

application/json

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

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

{
  "teams": [
    {
      "id": "text",
      "name": "text",
      "description": "text"
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create a team

post

Path parameters

organizationIdstringRequired

The id of the organization to find teams within

Body

namestringRequired

Responses

200

Expected response to a valid request

application/json

idstringRequired

namestringRequired

descriptionstringOptional

default

An error occurred

application/json

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

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

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "description": "text"
}

Get a team

get

Path parameters

organizationIdstringRequired

The id of the organization the team is within

teamIdstringRequired

The id of the team

Responses

200

A team

application/json

idstringRequired

namestringRequired

descriptionstringOptional

default

An error occurred

application/json

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

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

{
  "id": "text",
  "name": "text",
  "description": "text"
}

Update a team

post

Path parameters

organizationIdstringRequired

The id of the organization the team is within

teamIdstringRequired

The id of the team

Body

namestringRequired

Responses

200

Expected response to a valid request

application/json

idstringRequired

namestringRequired

descriptionstringOptional

default

An error occurred

application/json

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

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

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "description": "text"
}

Delete a team

delete

Path parameters

organizationIdstringRequired

The id of the organization the team is within

teamIdstringRequired

The id of the team

Responses

204

Team deleted

No content

default

An error occurred

application/json

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

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

No content