appcenter-cli

{ "swagger": "2.0", "info": { "version": "preview", "title": "App Center Client", "description": "Microsoft Visual Studio App Center API" }, "host": "api.appcenter.ms", "basePath": "/", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v0.1/users/{user_id}/devices/register": { "post": { "description": "Registers a user for an existing device", "parameters": [ { "name": "user_id", "type": "string", "in": "path", "description": "The ID of the user", "required": true }, { "name": "body", "description": "The device info.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DeviceInfoResponse" } }, "404": { "description": "not_found: The user or the device can't be found.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "operationId": "devices_registerUserForDevice", "security": [ { "APIToken": [] } ], "tags": [ "distribute" ] } }, "/v0.1/user/notifications/emailSettings": { "get": { "operationId": "notifications_getUserEmailSettings", "description": "Get Default email notification settings for the user", "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AlertUserEmailSettingsResult" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/AlertingError" } } }, "security": [ { "APIToken": [] } ], "tags": [ "alerting" ] } }, "/v0.1/user/invitations/orgs/{invitation_token}/reject": { "post": { "description": "Rejects a pending organization invitation", "parameters": [ { "$ref": "#/parameters/invitation_token" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_reject", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/user/invitations/orgs/{invitation_token}/accept": { "post": { "description": "Accepts a pending organization invitation for the specified user", "parameters": [ { "$ref": "#/parameters/invitation_token" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_accept", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/user/invitations/distribution_groups/accept": { "post": { "description": "Accepts all pending invitations to distribution groups for the specified user", "parameters": [], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "distributionGroupInvitations_acceptAll", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/user/invitations/apps/{invitation_token}/reject": { "post": { "description": "Rejects a pending invitation for the specified user", "parameters": [ { "$ref": "#/parameters/invitation_token" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "appInvitations_reject", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/user/invitations/apps/{invitation_token}/accept": { "post": { "description": "Accepts a pending invitation for the specified user", "parameters": [ { "$ref": "#/parameters/invitation_token" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "appInvitations_accept", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/user/export/serviceConnections": { "get": { "description": "Gets all service connections of the service type for GDPR export.", "parameters": [], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/SharedConnectionResponse" } } }, "default": { "description": "bad_request: proper details are not provided for connection in body.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "operationId": "sharedconnection_Connections", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/user/dsr/export/{token}/cancel": { "post": { "operationId": "DataSubjectRight_CancelExportRequest", "parameters": [ { "$ref": "#/parameters/DataSubjectRightRequestToken" } ], "responses": { "202": { "description": "Data subject right cancel export request has been accepted.", "headers": { "Location": { "type": "string", "description": "Link to get details about the cancel export." } }, "schema": { "$ref": "#/definitions/DataSubjectRightResponse" } }, "503": { "description": "Cancel export request cannot be processed yet.", "schema": { "$ref": "#/definitions/ErrorResponse" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "APIToken": [] } ], "tags": [ "gdpr" ] } }, "/v0.1/user/dsr/export/{token}": { "get": { "operationId": "DataSubjectRight_ExportStatusRequest", "parameters": [ { "$ref": "#/parameters/DataSubjectRightRequestToken" } ], "responses": { "200": { "description": "Data subject right export request status successfully retrieved.", "schema": { "$ref": "#/definitions/DataSubjectRightStatusResponse" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "APIToken": [] } ], "tags": [ "gdpr" ] } }, "/v0.1/user/dsr/export": { "post": { "operationId": "DataSubjectRight_ExportRequest", "parameters": [], "responses": { "202": { "description": "Data subject right export request has been accepted.", "headers": { "Location": { "type": "string", "description": "Link to get details about the export." } }, "schema": { "$ref": "#/definitions/DataSubjectRightResponse" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "APIToken": [] } ], "tags": [ "gdpr" ] } }, "/v0.1/user/dsr/delete/{token}/cancel": { "post": { "operationId": "DataSubjectRight_CancelDeleteRequest", "parameters": [ { "$ref": "#/parameters/DataSubjectRightRequestToken" }, { "name": "email", "in": "body", "schema": { "$ref": "#/definitions/DataSubjectRightEmailRequest" } } ], "responses": { "202": { "description": "Data subject right cancel delete request has been accepted.", "headers": { "Location": { "type": "string", "description": "Link to get details about the cancel delete." } }, "schema": { "$ref": "#/definitions/DataSubjectRightResponse" } }, "503": { "description": "Cancel delete request cannot be processed yet.", "schema": { "$ref": "#/definitions/ErrorResponse" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "APIToken": [] } ], "tags": [ "gdpr" ] } }, "/v0.1/user/dsr/delete/{token}": { "get": { "operationId": "DataSubjectRight_DeleteStatusRequest", "parameters": [ { "$ref": "#/parameters/DataSubjectRightRequestToken" }, { "$ref": "#/parameters/DataSubjectRightEmail" } ], "responses": { "200": { "description": "Data subject right delete request status successfully retrieved.", "schema": { "$ref": "#/definitions/DataSubjectRightStatusResponse" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "APIToken": [] } ], "tags": [ "gdpr" ] } }, "/v0.1/user/dsr/delete": { "post": { "operationId": "DataSubjectRight_DeleteRequest", "parameters": [], "responses": { "202": { "description": "Data subject right delete request has been accepted.", "headers": { "Location": { "type": "string", "description": "Link to get details about the delete." } }, "schema": { "$ref": "#/definitions/DataSubjectRightResponse" } }, "default": { "description": "Error code with reason", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "APIToken": [] } ], "tags": [ "gdpr" ] } }, "/v0.1/user/devices/{device_udid}": { "get": { "operationId": "devices_deviceDetails", "description": "Returns the device details.", "parameters": [ { "name": "device_udid", "type": "string", "in": "path", "description": "The UDID of the device", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DeviceInfoResponse" } }, "400": { "description": "bad_request: Devices information can only be requested for iOS apps.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "403": { "description": "forbidden: The user is not allowed to view someone else's device.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "404": { "description": "not_found: The user or device can't be found.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "security": [ { "APIToken": [] } ], "tags": [ "distribute" ] }, "delete": { "description": "Removes an existing device from a user", "parameters": [ { "name": "device_udid", "type": "string", "in": "path", "description": "The UDID of the device", "required": true } ], "responses": { "200": { "description": "Success" }, "403": { "description": "forbidden: The user is not allowed to delete someone else's device.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "404": { "description": "not_found: The user or the device can't be found.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "operationId": "devices_removeUserDevice", "security": [ { "APIToken": [] } ], "tags": [ "distribute" ] } }, "/v0.1/user/devices": { "get": { "operationId": "devices_userDevicesList", "description": "Returns all devices associated with the given user.", "parameters": [], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/DeviceInfoResponse" } } }, "400": { "description": "bad_request: Devices information can only be requested for iOS apps.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "403": { "description": "forbidden: The user is not allowed to view someone else's devices.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "404": { "description": "not_found: A user can't be found.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "security": [ { "APIToken": [] } ], "tags": [ "distribute" ] } }, "/v0.1/user": { "get": { "description": "Returns the user profile data", "parameters": [], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/UserProfileResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "users_get", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "patch": { "description": "Updates the user profile and returns the updated user data", "parameters": [ { "name": "user", "in": "body", "description": "The data for the created user", "required": true, "schema": { "$ref": "#/definitions/UserUpdateRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/UserProfileResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "users_update", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/tester/apps": { "get": { "operationId": "releases_listTesterApps", "description": "Return a list of applications that the user has tester permission to with the latest release for each.", "parameters": [], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/TesterAppWithReleaseResponse" } } } }, "security": [ { "APIToken": [] } ], "tags": [ "distribute" ] } }, "/v0.1/sdk/apps/{app_secret}/releases/{release_hash}": { "get": { "description": "Get a release with hash 'release_hash' or the 'latest' from all the distribution groups assigned to the current user.", "operationId": "releases_getLatestByHash", "parameters": [ { "name": "app_secret", "type": "string", "in": "path", "description": "The secret of the target application", "required": true }, { "name": "release_hash", "type": "string", "in": "path", "description": "The hash of the release or 'latest' to get the latest release from all the distribution groups assigned to the current user.", "required": true }, { "name": "udid", "type": "string", "in": "query", "description": "When passing `udid` in the query string, a provisioning check for the given device ID will be done. Will be ignored for non-iOS platforms.", "required": false } ], "responses": { "200": { "description": "If called with a specific `release_hash` return the app's 'display_name'' and 'buildIdentifier'. If 'release_hash' is 'latest' return the full release details of the latest release that was distributed to the current user (from all the distribution groups).", "schema": { "$ref": "#/definitions/ReleaseDetailsResponse" } }, "404": { "description": "Error codes:\n- `not_found` - A release or an app can't be found.\n- `no_releases_for_user` - No releases available for that user (will only be returned when `release_hash` is `latest`)\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "security": [ { "APIToken": [] } ], "tags": [ "distribute" ] } }, "/v0.1/public/sdk/apps/{app_secret}/distribution_groups/{distribution_group_id}/releases/latest": { "get": { "description": "Get a release with 'latest' for the given public group.", "operationId": "releases_getLatestByPublicDistributionGroup", "parameters": [ { "name": "app_secret", "type": "string", "in": "path", "description": "The secret of the target application", "required": true }, { "name": "distribution_group_id", "type": "string", "in": "path", "description": "the id for destination", "required": true } ], "responses": { "200": { "description": "The full release details of the latest release that was distributed from the given public group.", "schema": { "$ref": "#/definitions/ReleaseDetailsResponse" } }, "403": { "description": "Error Codes:\n- `forbidden` - Unauthorized to access private distribution group\n", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "404": { "description": "Error Codes:\n- `not_found` - Distribution group or the app doesn't exist\n- `no_releases_for_app` - App has no releases.\n", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "tags": [ "distribute" ] } }, "/v0.1/public/hooks": { "post": { "description": "Public webhook sink", "responses": { "200": { "description": "Success" }, "default": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ValidationErrorResponse" } } }, "operationId": "builds_webhook", "tags": [ "build" ] } }, "/v0.1/public/codepush/update_check": { "get": { "description": "Check for updates", "operationId": "codePushAcquisition_updateCheck", "parameters": [ { "name": "deployment_key", "in": "query", "required": true, "type": "string" }, { "name": "app_version", "in": "query", "required": true, "type": "string" }, { "name": "package_hash", "in": "query", "type": "string" }, { "name": "label", "in": "query", "type": "string" }, { "name": "client_unique_id", "in": "query", "type": "string" }, { "name": "is_companion", "in": "query", "type": "boolean" }, { "name": "previous_label_or_app_version", "in": "query", "type": "string" }, { "name": "previous_deployment_key", "in": "query", "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/UpdateCheckResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/Failure" } } }, "tags": [ "codepush" ] } }, "/v0.1/public/codepush/status": { "get": { "description": "Returns the acquisition service status to the caller", "operationId": "codePushAcquisition_getAcquisitionStatus", "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AcquisitionStatusSuccessResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/Failure" } } }, "tags": [ "codepush" ] } }, "/v0.1/public/codepush/report_status/download": { "post": { "description": "Report download of specified release", "operationId": "codePushAcquisition_updateDownloadStatus", "parameters": [ { "name": "release_metadata", "description": "Deployment status metric properties", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CodePushStatusMetricMetadata" } } ], "responses": { "200": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/Failure" } } }, "tags": [ "codepush" ] } }, "/v0.1/public/codepush/report_status/deploy": { "post": { "description": "Report Deployment status metric", "operationId": "codePushAcquisition_updateDeployStatus", "parameters": [ { "name": "release_metadata", "description": "Deployment status metric properties", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CodePushStatusMetricMetadata" } } ], "responses": { "200": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/Failure" } } }, "tags": [ "codepush" ] } }, "/v0.1/public/apps/{owner_name}/{app_name}/install_analytics": { "post": { "description": "Notify download(s) for the provided distribution release(s).", "operationId": "distibutionReleases_installAnalytics", "parameters": [ { "name": "owner_name", "type": "string", "in": "path", "description": "The name of the app owner", "required": true }, { "name": "app_name", "type": "string", "in": "path", "description": "The name of the app", "required": true }, { "name": "body", "in": "body", "description": "The install analytics request payload", "required": true, "schema": { "$ref": "#/definitions/AnalyticsReleasesResponse" } } ], "responses": { "204": { "description": "Install Analytics Notification Sent Successfully." } }, "tags": [ "distribute" ] } }, "/v0.1/public/apps/{app_id}/releases/{release_id}/ios_manifest": { "get": { "operationId": "releases_getIosManifest", "description": "Returns the manifest.plist in XML format for installing the release on a device. Only available for iOS.", "parameters": [ { "name": "app_id", "type": "string", "in": "path", "description": "The ID of the application", "required": true }, { "name": "release_id", "type": "integer", "in": "path", "description": "The release_id", "required": true }, { "name": "token", "type": "string", "in": "query", "description": "A hash that authorizes the download if it matches the release info.", "required": true } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The app's OS is not iOS.", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "403": { "description": "Forbidden - The token provided doesn't match the release's token.", "schema": { "$ref": "#/definitions/ErrorDetails" } }, "404": { "description": "The app or release can't be found.", "schema": { "$ref": "#/definitions/ErrorDetails" } } }, "tags": [ "distribute" ] } }, "/v0.1/orgs/{org_name}/users/{user_name}": { "patch": { "description": "Updates the given organization user", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/user_name" }, { "name": "organization_user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationUserPatchRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OrganizationUserResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "users_updateOrgRole", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "delete": { "description": "Removes a user from an organization.", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/user_name" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "users_removeFromOrg", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/users": { "get": { "description": "Returns a list of users that belong to an organization", "parameters": [ { "$ref": "#/parameters/organization_name" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationUserResponse" } } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "users_listForOrg", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/testers": { "get": { "description": "Returns a unique list of users including the whole organization members plus testers in any shared group of that org", "parameters": [ { "$ref": "#/parameters/organization_name" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/DistributionGroupTesterGetResponse" } } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "distributionGroups_listAllTestersForOrg", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/teams/{team_name}/users/{user_name}": { "delete": { "description": "Removes a user from a team that is owned by an organization", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" }, { "$ref": "#/parameters/user_name" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_removeUser", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/teams/{team_name}/users": { "get": { "description": "Returns the users of a team which is owned by an organization", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/TeamUserResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_getUsers", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "post": { "description": "Adds a new user to a team that is owned by an organization", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" }, { "name": "user_email", "in": "body", "description": "The email of the user to add to the team", "schema": { "$ref": "#/definitions/UserEmailRequest" } } ], "responses": { "201": { "description": "Success", "schema": { "$ref": "#/definitions/TeamUserResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_addUser", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/teams/{team_name}/apps/{app_name}": { "patch": { "description": "Updates the permissions the team has to the app", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" }, { "$ref": "#/parameters/app_name" }, { "name": "team", "in": "body", "schema": { "$ref": "#/definitions/TeamAppUpdateRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AppWithTeamPermissionsResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_updatePermissions", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "delete": { "description": "Removes an app from a team", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" }, { "$ref": "#/parameters/app_name" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_removeApp", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/teams/{team_name}/apps": { "post": { "description": "Adds an app to a team", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" }, { "name": "app", "in": "body", "description": "The name of the app to be added to the team. The app has to be owned by the organization.", "required": true, "schema": { "$ref": "#/definitions/AppAddRequest" } } ], "responses": { "201": { "description": "Success", "schema": { "$ref": "#/definitions/AppWithTeamPermissionsResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_addApp", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "get": { "description": "Returns the apps a team has access to", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/AppWithTeamPermissionsResponse" } } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_listApps", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/teams/{team_name}": { "get": { "description": "Returns the details of a single team", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/TeamResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_getTeam", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "delete": { "description": "Deletes a single team", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_delete", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "patch": { "description": "Updates a single team", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/team_name" }, { "name": "team", "in": "body", "description": "The information used to create the team", "schema": { "$ref": "#/definitions/TeamRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/TeamResponse" } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_update", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/teams": { "get": { "description": "Returns the list of all teams in this org", "parameters": [ { "$ref": "#/parameters/organization_name" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/TeamResponse" } } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_listAll", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "post": { "description": "Creates a team and returns it", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "name": "team", "in": "body", "description": "The information used to create the team", "schema": { "$ref": "#/definitions/TeamRequest" } } ], "responses": { "201": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/TeamResponse" } } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "teams_createTeam", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/invitations/{email}/revoke": { "post": { "description": "Removes a user's invitation to an organization", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/email" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/invitations/{email}/resend": { "post": { "description": "Cancels an existing organization invitation for the user and sends a new one", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/email" } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_sendNewInvitation", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/invitations/{email}": { "patch": { "description": "Allows the role of an invited user to be changed", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "$ref": "#/parameters/email" }, { "name": "user_role", "in": "body", "description": "The new role of the user", "required": true, "schema": { "$ref": "#/definitions/OrganizationUserPatchRequest" } } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_update", "security": [ { "APIToken": [] } ], "tags": [ "account" ] } }, "/v0.1/orgs/{org_name}/invitations": { "post": { "description": "Invites a new or existing user to an organization", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "name": "user_email", "in": "body", "description": "The email of the user to invite", "schema": { "$ref": "#/definitions/UserEmailRequest" } } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_create", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "delete": { "description": "Removes a user's invitation to an organization", "parameters": [ { "$ref": "#/parameters/organization_name" }, { "name": "user_email", "in": "body", "description": "The email of the user whose invitation should be removed", "schema": { "$ref": "#/definitions/UserEmailRequest" } } ], "responses": { "204": { "description": "Success" }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_delete", "security": [ { "APIToken": [] } ], "tags": [ "account" ] }, "get": { "description": "Gets the pending invitations for the organization", "parameters": [ { "$ref": "#/parameters/organization_name" } ], "responses": { "200": { "description": "Success", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationInvitationSimpleDetailResponse" } } }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "operationId": "orgInvitations_listPend