{
"openapi": "3.1.0",
"info": {
"title": "Account Chief API v1",
"version": "1.0.0",
"description": "Use OAuth2/OpenID Connect, a personal access token, or a team access token to authenticate with Account Chief.\n\nOAuth2/OpenID Connect is recommended for applications acting on behalf of users. Personal access tokens are available from your [Chief Tools account](https://account.chief.app/api/token/create). Team access tokens are available from the relevant [team](https://account.chief.app/teams).\n\nTeams are identified by their public slug. Numeric team IDs and billing details are internal and are not part of this API."
},
"servers": [
{
"url": "https://account.chief.app/api"
}
],
"tags": [
{
"name": "Teams",
"description": "Endpoints for retrieving teams."
},
{
"name": "Connected applications",
"description": "Endpoints for viewing applications connected to a team."
},
{
"name": "Invoices",
"description": "Endpoints for viewing team invoices."
},
{
"name": "Members",
"description": "Endpoints for viewing and managing team members."
},
{
"name": "Team access tokens",
"description": "Read-only endpoints for team access token metadata."
}
],
"security": [
{
"openid": []
},
{
"ctp": []
},
{
"ctt": []
}
],
"paths": {
"/v1/teams": {
"get": {
"operationId": "v1.teams.index",
"description": "List the teams available to the authenticated credential. A team access token only returns its own team.\nFor user credentials, `accountchief:team:read` is also accepted in place of the `teams` scope.",
"summary": "List teams",
"tags": [
"Teams"
],
"responses": {
"200": {
"description": "Array of `Team`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Team"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
},
"security": [
{
"openid": [
"teams"
]
},
{
"openid": [
"accountchief:team:read"
]
},
{
"ctp": [
"teams"
]
},
{
"ctp": [
"accountchief:team:read"
]
},
{
"ctt": []
}
]
}
},
"/v1/teams/{teamSlug}/apps": {
"get": {
"operationId": "v1.teams.apps.index",
"description": "List all applications connected to a team.",
"summary": "List connected applications",
"tags": [
"Connected applications"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number to return.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "Number of items to return per page.",
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TeamConnectedApp`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamConnectedApp"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:apps:read"
]
},
{
"ctp": [
"accountchief:team:apps:read"
]
},
{
"ctt": [
"accountchief:team:apps:read"
]
}
]
}
},
"/v1/teams/{teamSlug}/invoices": {
"get": {
"operationId": "v1.teams.invoices.index",
"description": "List all invoices issued to a team.",
"summary": "List invoices",
"tags": [
"Invoices"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number to return.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "Number of items to return per page.",
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
}
},
{
"name": "app_id",
"in": "query",
"description": "Application identifier to filter invoices by.",
"schema": {
"type": "string",
"enum": [
"domainchief",
"certchief",
"deploychief",
"tny",
"flowguard",
"backupchief",
"socketchief",
"billdo"
]
}
},
{
"name": "sort",
"in": "query",
"description": "Invoice date sort direction. Use `desc` for newest first or `asc` for oldest first.",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
},
{
"name": "expand[]",
"in": "query",
"description": "Related resource to include. The supported value is `lines`.",
"schema": {
"type": "array",
"enum": [
"lines"
],
"items": {
"type": "string",
"enum": [
"lines"
]
}
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TeamInvoice`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamInvoice"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:invoices:read"
]
},
{
"ctp": [
"accountchief:team:invoices:read"
]
},
{
"ctt": [
"accountchief:team:invoices:read"
]
}
]
}
},
"/v1/teams/{teamSlug}/members": {
"get": {
"operationId": "v1.teams.members.index",
"description": "List all users who are members of a team.",
"summary": "List team members",
"tags": [
"Members"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number to return.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "Number of items to return per page.",
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TeamMember`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamMember"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:members:read"
]
},
{
"ctp": [
"accountchief:team:members:read"
]
},
{
"ctt": [
"accountchief:team:members:read"
]
}
]
}
},
"/v1/teams/{teamSlug}/tokens": {
"get": {
"operationId": "v1.teams.tokens.index",
"description": "List metadata for all access tokens belonging to a team. Token values cannot be retrieved.",
"summary": "List team access tokens",
"tags": [
"Team access tokens"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number to return.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "Number of items to return per page.",
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TeamToken`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamToken"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:tokens:read"
]
},
{
"ctp": [
"accountchief:team:tokens:read"
]
},
{
"ctt": [
"accountchief:team:tokens:read"
]
}
]
}
},
"/v1/teams/{teamSlug}/apps/{appId}": {
"get": {
"operationId": "v1.teams.apps.single",
"description": "Retrieve a single application connected to a team.",
"summary": "Show connected application",
"tags": [
"Connected applications"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "appId",
"in": "path",
"required": true,
"description": "application identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`TeamConnectedApp`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TeamConnectedApp"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
},
"security": [
{
"openid": [
"accountchief:team:apps:read"
]
},
{
"ctp": [
"accountchief:team:apps:read"
]
},
{
"ctt": [
"accountchief:team:apps:read"
]
}
]
}
},
"/v1/teams/{teamSlug}/invoices/{invoiceId}": {
"get": {
"operationId": "v1.teams.invoices.single",
"description": "Retrieve a single invoice issued to a team.",
"summary": "Show invoice",
"tags": [
"Invoices"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "invoice identifier",
"schema": {
"type": "string"
}
},
{
"name": "expand[]",
"in": "query",
"description": "Related resource to include. The supported value is `lines`.",
"schema": {
"type": "array",
"enum": [
"lines"
],
"items": {
"type": "string",
"enum": [
"lines"
]
}
}
}
],
"responses": {
"200": {
"description": "`TeamInvoice`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TeamInvoice"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:invoices:read"
]
},
{
"ctp": [
"accountchief:team:invoices:read"
]
},
{
"ctt": [
"accountchief:team:invoices:read"
]
}
]
}
},
"/v1/teams/{teamSlug}/members/{userId}": {
"get": {
"operationId": "v1.teams.members.single",
"description": "Retrieve a single user who is a member of a team.",
"summary": "Show team member",
"tags": [
"Members"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"description": "user identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`TeamMember`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TeamMember"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
},
"security": [
{
"openid": [
"accountchief:team:members:read"
]
},
{
"ctp": [
"accountchief:team:members:read"
]
},
{
"ctt": [
"accountchief:team:members:read"
]
}
]
},
"patch": {
"operationId": "v1.teams.members.update",
"description": "Change a team member's role.",
"summary": "Update team member role",
"tags": [
"Members"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"description": "user identifier",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamUpdateMemberRoleRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "An error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview.",
"examples": [
"A team must retain at least one owner."
]
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:members:write"
]
},
{
"ctp": [
"accountchief:team:members:write"
]
},
{
"ctt": [
"accountchief:team:members:write"
]
}
]
},
"delete": {
"operationId": "v1.teams.members.remove",
"description": "Remove a user from a team. A team's final owner cannot be removed.",
"summary": "Remove team member",
"tags": [
"Members"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"description": "user identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "An error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview.",
"examples": [
"A team must retain at least one owner."
]
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
},
"security": [
{
"openid": [
"accountchief:team:members:write"
]
},
{
"ctp": [
"accountchief:team:members:write"
]
},
{
"ctt": [
"accountchief:team:members:write"
]
}
]
}
},
"/v1/teams/{teamSlug}/invitations": {
"post": {
"operationId": "v1.teams.members.invite",
"description": "Send an expiring team invitation to an email address.",
"summary": "Invite team member",
"tags": [
"Members"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamInviteMemberRequest"
}
}
}
},
"responses": {
"202": {
"description": ""
},
"429": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "An invitation was sent to this email recently."
}
},
"required": [
"message"
]
}
}
},
"headers": {
"Retry-After": {
"schema": {
"type": "integer"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:members:write"
]
},
{
"ctp": [
"accountchief:team:members:write"
]
},
{
"ctt": [
"accountchief:team:members:write"
]
}
]
}
},
"/v1/teams/{teamSlug}/tokens/{tokenId}": {
"get": {
"operationId": "v1.teams.tokens.single",
"description": "Retrieve metadata for a single team access token. The token value cannot be retrieved.",
"summary": "Show team access token",
"tags": [
"Team access tokens"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
},
{
"name": "tokenId",
"in": "path",
"required": true,
"description": "token identifier",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`TeamToken`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TeamToken"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
},
"security": [
{
"openid": [
"accountchief:team:tokens:read"
]
},
{
"ctp": [
"accountchief:team:tokens:read"
]
},
{
"ctt": [
"accountchief:team:tokens:read"
]
}
]
}
},
"/v1/teams/{teamSlug}": {
"get": {
"operationId": "v1.teams.single",
"description": "Retrieve a team available to the authenticated credential. A team access token can only retrieve its own team.\nFor user credentials, `accountchief:team:read` is also accepted in place of the `teams` scope.",
"summary": "Show team",
"tags": [
"Teams"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`Team`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Team"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
},
"security": [
{
"openid": [
"teams"
]
},
{
"openid": [
"accountchief:team:read"
]
},
{
"ctp": [
"teams"
]
},
{
"ctp": [
"accountchief:team:read"
]
},
{
"ctt": []
}
]
},
"patch": {
"operationId": "v1.teams.update",
"description": "Update the display name, Gravatar email, or timezone of an accessible team.",
"summary": "Update team settings",
"tags": [
"Teams"
],
"parameters": [
{
"name": "teamSlug",
"in": "path",
"required": true,
"description": "team slug",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "`Team`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
},
{
"type": "object",
"required": [
"billing_team",
"linked_teams"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
},
"security": [
{
"openid": [
"accountchief:team:write"
]
},
{
"ctp": [
"accountchief:team:write"
]
},
{
"ctt": [
"accountchief:team:write"
]
}
]
}
}
},
"components": {
"securitySchemes": {
"openid": {
"type": "openIdConnect",
"description": "Chief Tools OAuth2/OpenID Connect access token.",
"openIdConnectUrl": "https://account.chief.app/.well-known/openid-configuration"
},
"ctp": {
"type": "http",
"description": "Chief Tools personal access token.",
"scheme": "bearer",
"bearerFormat": "ctp_*"
},
"ctt": {
"type": "http",
"description": "Chief Tools team access token.",
"scheme": "bearer",
"bearerFormat": "ctt_*"
}
},
"schemas": {
"AppId": {
"type": "string",
"description": "| |\n|---|\n| `domainchief`
Domain Chief. |\n| `certchief`
Cert Chief. |\n| `deploychief`
Deploy Chief. |\n| `tny`
Tny. |\n| `flowguard`
FlowGuard. |\n| `backupchief`
Backup Chief. |\n| `socketchief`
Socket Chief. |\n| `billdo`
Bill.DO. |",
"x-extensible-enum": [
"domainchief",
"certchief",
"deploychief",
"tny",
"flowguard",
"backupchief",
"socketchief",
"billdo"
],
"title": "AppId"
},
"Team": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Identifier of the team."
},
"name": {
"type": "string",
"description": "Display name of the team."
},
"role": {
"anyOf": [
{
"description": "Current user's role, or `null` for a team credential.",
"$ref": "#/components/schemas/TeamMembershipRole"
},
{
"type": "null"
}
]
},
"avatar": {
"type": "string",
"description": "URL of the team avatar."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "IANA timezone used by the team."
},
"avatar_hash": {
"type": [
"string",
"null"
],
"description": "Version identifier for the current avatar."
},
"gravatar_email": {
"type": [
"string",
"null"
],
"description": "Email address used to resolve the team's Gravatar."
},
"billing_team": {
"anyOf": [
{
"description": "Billing team used by this team, when billing is linked.",
"$ref": "#/components/schemas/TeamReference"
},
{
"type": "null"
}
]
},
"linked_teams": {
"type": "array",
"description": "Teams whose billing is linked to this team.",
"items": {
"$ref": "#/components/schemas/TeamReference"
}
}
},
"required": [
"slug",
"name",
"role",
"avatar",
"timezone",
"avatar_hash",
"gravatar_email"
],
"title": "Team"
},
"TeamBillingCurrency": {
"type": "string",
"description": "| |\n|---|\n| `EUR`
Euro. |\n| `USD`
United States dollar. |",
"x-extensible-enum": [
"EUR",
"USD"
],
"title": "TeamBillingCurrency"
},
"TeamConnectedApp": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Application identifier."
},
"name": {
"type": "string",
"description": "Application display name."
},
"plan": {
"anyOf": [
{
"description": "Effective plan inherited from the billing team when applicable.",
"$ref": "#/components/schemas/TeamConnectedAppPlan"
},
{
"type": "null"
}
]
},
"limits": {
"type": "array",
"description": "Effective limits combined with usage reported by this team.",
"items": {
"$ref": "#/components/schemas/TeamConnectedAppLimit"
}
}
},
"required": [
"id",
"name",
"plan",
"limits"
],
"title": "TeamConnectedApp"
},
"TeamConnectedAppLimit": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Limit identifier."
},
"unit": {
"type": [
"string",
"null"
],
"description": "Unit counted by this limit."
},
"limit": {
"type": [
"integer",
"null"
],
"description": "Maximum allowed usage, or `null` when usage is unlimited."
},
"unlimited": {
"type": "boolean",
"description": "Indicates whether usage is unlimited."
},
"usage": {
"type": [
"integer",
"null"
],
"description": "Usage reported by the requested team, or `null` when the application does not report usage."
}
},
"required": [
"id",
"unit",
"limit",
"unlimited",
"usage"
],
"title": "TeamConnectedAppLimit"
},
"TeamConnectedAppPlan": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Plan identifier."
},
"name": {
"type": "string",
"description": "Plan display name."
},
"is_free": {
"type": "boolean",
"description": "Indicates whether the plan has no recurring price."
}
},
"required": [
"id",
"name",
"is_free"
],
"title": "TeamConnectedAppPlan"
},
"TeamInviteMemberRequest": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Email address to invite to the team."
},
"role": {
"type": [
"string",
"null"
],
"description": "Role assigned after acceptance.",
"enum": [
"owner",
"member",
"billing",
null
]
},
"accessible_app_ids": {
"type": [
"array",
"null"
],
"description": "Application IDs this member can access. Null grants all team applications.",
"items": {
"type": "string",
"enum": [
"domainchief",
"certchief",
"deploychief",
"tny",
"flowguard",
"backupchief",
"socketchief",
"billdo"
]
},
"uniqueItems": true
}
},
"required": [
"email"
],
"title": "TeamInviteMemberRequest"
},
"TeamInvoice": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Invoice identifier."
},
"number": {
"type": [
"string",
"null"
],
"description": "Human-readable invoice number, or `null` before one is assigned."
},
"app": {
"type": [
"object",
"null"
],
"description": "Application that issued the invoice.",
"properties": {
"id": {
"description": "Application identifier.\n| |\n|---|\n| `domainchief`
Domain Chief. |\n| `certchief`
Cert Chief. |\n| `deploychief`
Deploy Chief. |\n| `tny`
Tny. |\n| `flowguard`
FlowGuard. |\n| `backupchief`
Backup Chief. |\n| `socketchief`
Socket Chief. |\n| `billdo`
Bill.DO. |",
"$ref": "#/components/schemas/AppId"
},
"name": {
"type": [
"string",
"null"
],
"description": "Application display name."
}
},
"required": [
"id",
"name"
]
},
"status": {
"description": "Current invoice status.\n| |\n|---|\n| `draft`
The invoice is still being prepared and cannot be paid yet. |\n| `open`
The invoice is finalized and awaiting payment. |\n| `pending`
Payment processing has started but has not completed. |\n| `paid`
The invoice has been paid. |\n| `uncollectible`
The invoice is unlikely to be paid and has been marked uncollectible. |\n| `void`
The invoice was cancelled. |",
"$ref": "#/components/schemas/TeamInvoiceStatus"
},
"invoice_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date and time the invoice was issued."
},
"total": {
"type": "integer",
"description": "Total in the invoice currency's minor unit."
},
"currency": {
"description": "ISO 4217 currency code used for monetary amounts.\n| |\n|---|\n| `EUR`
Euro. |\n| `USD`
United States dollar. |",
"$ref": "#/components/schemas/TeamBillingCurrency"
},
"line_count": {
"type": "integer",
"description": "Number of line items on the invoice."
},
"memo": {
"type": [
"string",
"null"
],
"description": "Optional note attached to the invoice."
},
"payment_pending": {
"type": "boolean",
"description": "Indicates whether payment processing is still pending."
},
"hosted_url": {
"type": [
"string",
"null"
],
"description": "Provider-hosted page for viewing or paying the invoice."
},
"pdf_url": {
"type": [
"string",
"null"
],
"description": "Temporary invoice PDF URL valid for one hour."
},
"lines": {
"type": [
"array",
"null"
],
"description": "Invoice line items when expanded, otherwise `null`.",
"items": {
"$ref": "#/components/schemas/TeamInvoiceLine"
}
}
},
"required": [
"id",
"number",
"app",
"status",
"invoice_date",
"total",
"currency",
"lines"
],
"title": "TeamInvoice"
},
"TeamInvoiceLine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Invoice line identifier assigned by the source application."
},
"source_team": {
"type": [
"object",
"null"
],
"description": "Team that generated the line.",
"properties": {
"slug": {
"type": [
"string",
"null"
],
"description": "Team slug."
},
"name": {
"type": [
"string",
"null"
],
"description": "Team name at the time the invoice was created."
}
},
"required": [
"slug",
"name"
]
},
"description": {
"type": "string",
"description": "Human-readable line description."
},
"amount": {
"type": "integer",
"description": "Amount in the invoice currency's minor unit."
},
"category": {
"type": [
"object",
"null"
],
"description": "Optional category assigned by the source application.",
"properties": {
"key": {
"type": [
"string",
"null"
],
"description": "Machine-readable category identifier."
},
"label": {
"type": [
"string",
"null"
],
"description": "Human-readable category name."
}
},
"required": [
"key",
"label"
]
},
"resource": {
"type": [
"object",
"null"
],
"description": "Resource billed by this line, when supplied by the source application.",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"type",
"label"
]
},
"period_start": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Start of the billing period covered by this line."
},
"period_end": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "End of the billing period covered by this line."
}
},
"required": [
"id",
"source_team",
"description",
"amount",
"category",
"resource",
"period_start",
"period_end"
],
"title": "TeamInvoiceLine"
},
"TeamInvoiceStatus": {
"type": "string",
"description": "| |\n|---|\n| `draft`
The invoice is still being prepared and cannot be paid yet. |\n| `open`
The invoice is finalized and awaiting payment. |\n| `pending`
Payment processing has started but has not completed. |\n| `paid`
The invoice has been paid. |\n| `uncollectible`
The invoice is unlikely to be paid and has been marked uncollectible. |\n| `void`
The invoice was cancelled. |",
"x-extensible-enum": [
"draft",
"open",
"pending",
"paid",
"uncollectible",
"void"
],
"title": "TeamInvoiceStatus"
},
"TeamMember": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "User identifier."
},
"name": {
"type": "string",
"description": "User display name."
},
"role": {
"description": "Current membership role.",
"$ref": "#/components/schemas/TeamMembershipRole"
},
"accessible_app_ids": {
"type": [
"array",
"null"
],
"description": "Application IDs this member can access. Null grants all team applications.",
"items": {
"type": "string"
}
},
"email": {
"type": "string",
"description": "User email address."
},
"avatar": {
"type": "string",
"description": "URL of the user's avatar."
},
"joined_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date and time the user joined the team."
}
},
"required": [
"id",
"name",
"role",
"accessible_app_ids",
"email",
"avatar",
"joined_at"
],
"title": "TeamMember"
},
"TeamMembershipRole": {
"type": "string",
"x-extensible-enum": [
"owner",
"member",
"billing"
],
"title": "TeamMembershipRole"
},
"TeamReference": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Identifier of the team."
},
"name": {
"type": "string",
"description": "Display name of the team."
}
},
"required": [
"slug",
"name"
],
"title": "TeamReference"
},
"TeamToken": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Token identifier."
},
"name": {
"type": "string",
"description": "Token display name."
},
"scopes": {
"type": "array",
"description": "Permissions granted to the token.",
"items": {
"type": "string"
}
},
"creator": {
"type": [
"object",
"null"
],
"description": "User who created the token, or `null` when unavailable.",
"properties": {
"id": {
"type": "string",
"description": "User identifier."
},
"name": {
"type": "string",
"description": "User display name."
},
"email": {
"type": "string",
"description": "User email address."
}
},
"required": [
"id",
"name",
"email"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time the token was created."
},
"last_used_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date and time the token was last used."
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date and time the token expires, or `null` when it does not expire."
}
},
"required": [
"id",
"name",
"scopes",
"creator",
"created_at",
"last_used_at",
"expires_at"
],
"title": "TeamToken"
},
"TeamUpdateMemberRoleRequest": {
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "New membership role.",
"enum": [
"owner",
"member",
"billing"
]
},
"accessible_app_ids": {
"type": [
"array",
"null"
],
"description": "Application IDs this member can access. Null grants all team applications.",
"items": {
"type": "string",
"enum": [
"domainchief",
"certchief",
"deploychief",
"tny",
"flowguard",
"backupchief",
"socketchief",
"billdo"
]
},
"uniqueItems": true
}
},
"title": "TeamUpdateMemberRoleRequest"
},
"TeamUpdateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Team display name.",
"minLength": 1,
"maxLength": 255
},
"timezone": {
"type": [
"string",
"null"
],
"description": "IANA timezone used by the team.",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Coyhaique",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"UTC",
null
]
},
"gravatar_email": {
"type": [
"string",
"null"
],
"format": "email",
"description": "Email address used to resolve the team's Gravatar."
}
},
"title": "TeamUpdateRequest"
}
},
"responses": {
"AuthenticationException": {
"description": "Unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ValidationException": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"AuthorizationException": {
"description": "Authorization error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ModelNotFoundException": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
}
}
}
}