Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CommunicationTurn swagger and add CommunicationIdentity swagger to preview folder #12881

Merged
merged 6 commits into from
Feb 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
{
"swagger": "2.0",
"info": {
"title": "CommunicationIdentityClient",
"description": "Azure Communication Identity Service",
"version": "2021-02-22-preview1"
apattath marked this conversation as resolved.
Show resolved Hide resolved
},
"paths": {
"/identities": {
"post": {
"tags": [
"Identity"
],
"summary": "Create a new identity.",
"operationId": "CommunicationIdentity_Create",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/CommunicationIdentityCreateRequest"
}
}
],
"responses": {
"default": {
"description": "Error",
"schema": {
"$ref": "../../../Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse"
}
},
"201": {
"description": "Created - Returns the created identity.",
"schema": {
"$ref": "#/definitions/CommunicationIdentityAccessTokenResult"
}
}
},
"x-ms-examples": {
"Create an Identity": {
"$ref": "./examples/CreateIdentity.json"
}
}
}
},
"/identities/{id}": {
"delete": {
"tags": [
"Identity"
],
"summary": "Delete the identity, revoke all tokens for the identity and delete all associated data.",
"operationId": "CommunicationIdentity_Delete",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Identifier of the identity to be deleted.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"default": {
"description": "Error",
"schema": {
"$ref": "../../../Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse"
}
},
"204": {
"description": "Success"
}
},
"x-ms-examples": {
"Delete an identity": {
"$ref": "./examples/DeleteIdentity.json"
}
}
}
},
"/identities/{id}/:revokeAccessTokens": {
"post": {
"tags": [
"Identity"
],
"summary": "Revoke all access tokens for the specific identity.",
"operationId": "CommunicationIdentity_RevokeAccessTokens",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Identifier of the identity.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"default": {
"description": "Error",
"schema": {
"$ref": "../../../Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse"
}
},
"204": {
"description": "Success"
}
},
"x-ms-examples": {
"Revoke access tokens": {
"$ref": "./examples/RevokeAccessTokens.json"
}
}
}
},
"/identities/{id}/:issueAccessToken": {
"post": {
"tags": [
"Token"
],
"summary": "Issue a new token for an identity.",
"operationId": "CommunicationIdentity_IssueAccessToken",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Identifier of the identity to issue token for.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "Requesting scopes for the new token.",
"required": true,
"schema": {
"$ref": "#/definitions/CommunicationIdentityAccessTokenRequest"
}
}
],
"responses": {
"default": {
"description": "Error",
"schema": {
"$ref": "../../../Microsoft.CommunicationServicesCommon/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse"
}
},
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CommunicationIdentityAccessToken"
}
}
},
"x-ms-examples": {
"Issue an access token": {
"$ref": "./examples/IssueAccessToken.json"
}
}
}
}
},
"definitions": {
"CommunicationIdentityTokenScope": {
"description": "List of scopes for an access token.",
"enum": [
"chat",
"voip"
],
"type": "string",
"x-ms-enum": {
"name": "CommunicationIdentityTokenScope",
"modelAsString": true
}
},
"CommunicationIdentityCreateRequest": {
"type": "object",
"properties": {
"createTokenWithScopes": {
"description": "Also create access token for the created identity.",
"type": "array",
"items": {
"$ref": "#/definitions/CommunicationIdentityTokenScope"
}
}
}
},
"CommunicationIdentity": {
"description": "A communication identity.",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"description": "Identifier of the identity.",
"type": "string"
}
}
},
"CommunicationIdentityAccessToken": {
"description": "An access token.",
"required": [
"expiresOn",
"token"
],
"type": "object",
"properties": {
"token": {
"description": "The access token issued for the identity.",
"type": "string"
},
"expiresOn": {
"format": "date-time",
"description": "The expiry time of the token.",
"type": "string"
}
}
},
"CommunicationIdentityAccessTokenResult": {
"description": "A communication identity with access token.",
"required": [
"identity"
],
"type": "object",
"properties": {
"identity": {
"$ref": "#/definitions/CommunicationIdentity"
},
"accessToken": {
"$ref": "#/definitions/CommunicationIdentityAccessToken"
}
}
},
"CommunicationIdentityAccessTokenRequest": {
"required": [
"scopes"
],
"type": "object",
"properties": {
"scopes": {
"description": "List of scopes attached to the token.",
"type": "array",
"items": {
"$ref": "#/definitions/CommunicationIdentityTokenScope"
}
}
}
}
},
"parameters": {
"ApiVersionParameter": {
"in": "query",
"name": "api-version",
"description": "Version of API to invoke.",
"required": true,
"type": "string"
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"name": "endpoint",
"description": "The communication resource, for example https://my-resource.communication.azure.com",
"required": true,
"type": "string",
"in": "path",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
}
]
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"parameters": {
"api-version": "2021-03-07",
"content-type": "application/json",
"endpoint": "https://my-resource.communication.azure.com",
"body": {
"createTokenWithScopes": [
"chat"
]
}
},
"responses": {
"201": {
"body": {
"identity": {
"id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081"
},
"accessToken": {
"token": "token",
"expiresOn": "2020-09-10T21:39:39.3244584+00:00"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"parameters": {
"api-version": "2021-03-07",
"content-type": "application/json",
"id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081",
"endpoint": "https://my-resource.communication.azure.com"
},
"responses": {
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"parameters": {
"api-version": "2021-03-07",
"content-type": "application/merge-patch+json",
"id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081",
"body": {
"scopes": [
"chat"
]
},
"endpoint": "https://my-resource.communication.azure.com"
},
"responses": {
"200": {
"body": {
"token": "token",
"expiresOn": "2020-09-10T21:39:39.3244584+00:00"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"parameters": {
"api-version": "2021-03-07",
"content-type": "application/json",
"id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081",
"endpoint": "https://my-resource.communication.azure.com"
},
"responses": {
"204": {}
}
}
Loading