Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-identity

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CommunicationIdentityCreateResponse

CommunicationIdentityCreateResponse: CommunicationIdentityAccessTokenResult

Contains response data for the create operation.

CommunicationIdentityExchangeTeamsUserAccessTokenResponse

CommunicationIdentityExchangeTeamsUserAccessTokenResponse: CommunicationIdentityAccessToken

Contains response data for the exchangeTeamsUserAccessToken operation.

CommunicationIdentityIssueAccessTokenResponse

CommunicationIdentityIssueAccessTokenResponse: CommunicationIdentityAccessToken

Contains response data for the issueAccessToken operation.

CommunicationIdentityTokenScope

CommunicationIdentityTokenScope: string

Defines values for CommunicationIdentityTokenScope.
KnownCommunicationIdentityTokenScope can be used interchangeably with CommunicationIdentityTokenScope, this enum contains the known values that the service supports.

Known values supported by the service

chat
voip

TokenScope

TokenScope: "chat" | "voip"

Represents the scope of the token.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.1.0-beta.2"

Const logger

logger: any = createClientLogger("communication-identity")

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

Const isCommunicationIdentityClientOptions

  • isCommunicationIdentityClientOptions(options: any): options is CommunicationIdentityClientOptions

Object literals

Const CommunicationError

CommunicationError: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const CommunicationErrorResponse

CommunicationErrorResponse: object

type

type: object

className

className: string = "CommunicationErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

Const CommunicationIdentity

CommunicationIdentity: object

type

type: object

className

className: string = "CommunicationIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const CommunicationIdentityAccessToken

CommunicationIdentityAccessToken: object

type

type: object

className

className: string = "CommunicationIdentityAccessToken"

name

name: string = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "expiresOn"

type

type: object

name

name: string = "DateTime"

token

token: object

required

required: boolean = true

serializedName

serializedName: string = "token"

type

type: object

name

name: string = "String"

Const CommunicationIdentityAccessTokenRequest

CommunicationIdentityAccessTokenRequest: object

type

type: object

className

className: string = "CommunicationIdentityAccessTokenRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

scopes

scopes: object

required

required: boolean = true

serializedName

serializedName: string = "scopes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const CommunicationIdentityAccessTokenResult

CommunicationIdentityAccessTokenResult: object

type

type: object

className

className: string = "CommunicationIdentityAccessTokenResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "accessToken"

type

type: object

className

className: string = "CommunicationIdentityAccessToken"

name

name: string = "Composite"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "CommunicationIdentity"

name

name: string = "Composite"

Const CommunicationIdentityCreateRequest

CommunicationIdentityCreateRequest: object

type

type: object

className

className: string = "CommunicationIdentityCreateRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

createTokenWithScopes

createTokenWithScopes: object

serializedName

serializedName: string = "createTokenWithScopes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const TeamsUserAccessTokenRequest

TeamsUserAccessTokenRequest: object

type

type: object

className

className: string = "TeamsUserAccessTokenRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

token

token: object

required

required: boolean = true

serializedName

serializedName: string = "token"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-10-31-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createOperationSpec

createOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/identities"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.CommunicationIdentityCreateRequest

parameterPath

parameterPath: object

createTokenWithScopes

createTokenWithScopes: Object = ["options", "createTokenWithScopes"]

responses

responses: object

201

201: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentityAccessTokenResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const createTokenWithScopes

createTokenWithScopes: object

mapper

mapper: any = CommunicationIdentityCreateRequestMapper

parameterPath

parameterPath: Object = ["options", "createTokenWithScopes"]

Const deleteOperationSpec

deleteOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/identities/{id}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.id]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const exchangeTeamsUserAccessTokenOperationSpec

exchangeTeamsUserAccessTokenOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/teamsUser/:exchangeAccessToken"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

token

token: Object = ["token"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentityAccessToken

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const id

id: object

parameterPath

parameterPath: string = "id"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const issueAccessTokenOperationSpec

issueAccessTokenOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/identities/{id}/:issueAccessToken"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.id]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

scopes

scopes: Object = ["scopes"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentityAccessToken

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const revokeAccessTokensOperationSpec

revokeAccessTokensOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/identities/{id}/:revokeAccessTokens"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.id]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const scopes

scopes: object

mapper

mapper: any = CommunicationIdentityAccessTokenRequestMapper

parameterPath

parameterPath: string = "scopes"

Const token

token: object

mapper

mapper: any = TeamsUserAccessTokenRequestMapper

parameterPath

parameterPath: string = "token"

Generated using TypeDoc