CommunicationIdentityOperations | @azure/communication-administration

Class representing a CommunicationIdentityOperations.

Hierarchy

CommunicationIdentityOperations

Index

Constructors

constructor

Methods

Constructors

constructor

new CommunicationIdentityOperations(client: GeneratedCommunicationIdentityClientContext): CommunicationIdentityOperations

- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:19
Create a CommunicationIdentityOperations.

Parameters
- client: GeneratedCommunicationIdentityClientContext
  
  Reference to the service client.
Returns CommunicationIdentityOperations

Methods

create

create(endpoint: string, options?: coreHttp.RequestOptionsBase): Promise<Models.CommunicationIdentityCreateResponse>
create(endpoint: string, callback: coreHttp.ServiceCallback<CommunicationIdentity>): void
create(endpoint: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<CommunicationIdentity>): void

- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:35
summary

Create a new identity.

Parameters
- endpoint: string
  
  Auth and Identity endpoint
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.CommunicationIdentityCreateResponse>

Promise<Models.CommunicationIdentityCreateResponse>
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:43
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- callback: coreHttp.ServiceCallback<CommunicationIdentity>
  
  The callback
Returns void
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:49
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<CommunicationIdentity>
  
  The callback
Returns void

deleteMethod

deleteMethod(endpoint: string, id: string, options?: coreHttp.RequestOptionsBase): Promise<coreHttp.RestResponse>
deleteMethod(endpoint: string, id: string, callback: coreHttp.ServiceCallback<void>): void
deleteMethod(endpoint: string, id: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<void>): void

- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:76
summary

Delete the identity, revoke all tokens of the identity and delete all associated data.

Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity to be deleted.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:86
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity to be deleted.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:93
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity to be deleted.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

issueToken

issueToken(endpoint: string, id: string, scopes: string[], options?: coreHttp.RequestOptionsBase): Promise<Models.CommunicationIdentityIssueTokenResponse>
issueToken(endpoint: string, id: string, scopes: string[], callback: coreHttp.ServiceCallback<CommunicationIdentityToken>): void
issueToken(endpoint: string, id: string, scopes: string[], options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<CommunicationIdentityToken>): void

- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:171
summary

Generate a new token for an identity.

Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity to issue token for.
- scopes: string[]
  
  List of scopes attached to the token.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.CommunicationIdentityIssueTokenResponse>

Promise<Models.CommunicationIdentityIssueTokenResponse>
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:183
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity to issue token for.
- scopes: string[]
  
  List of scopes attached to the token.
- callback: coreHttp.ServiceCallback<CommunicationIdentityToken>
  
  The callback
Returns void
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:196
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity to issue token for.
- scopes: string[]
  
  List of scopes attached to the token.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<CommunicationIdentityToken>
  
  The callback
Returns void

update

update(endpoint: string, id: string, options?: Models.CommunicationIdentityUpdateOptionalParams): Promise<coreHttp.RestResponse>
update(endpoint: string, id: string, callback: coreHttp.ServiceCallback<void>): void
update(endpoint: string, id: string, options: CommunicationIdentityUpdateOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:123
summary

Update an Identity.

Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity.
- Optional options: Models.CommunicationIdentityUpdateOptionalParams
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:133
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in communicationIdentity/generated/src/operations/communicationIdentityOperations.ts:140
Parameters
- endpoint: string
  
  Auth and Identity endpoint
- id: string
  
  Identifier of the identity.
- options: CommunicationIdentityUpdateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: GeneratedCommunicationIdentityClientContext

Returns CommunicationIdentityOperations

Methods

create

Parameters

endpoint: string

Optional options: coreHttp.RequestOptionsBase

Returns Promise<Models.CommunicationIdentityCreateResponse>

Parameters

endpoint: string

callback: coreHttp.ServiceCallback<CommunicationIdentity>

Returns void

Parameters

endpoint: string

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<CommunicationIdentity>

Returns void

deleteMethod

Parameters

endpoint: string

id: string

Optional options: coreHttp.RequestOptionsBase

Returns Promise<coreHttp.RestResponse>

Parameters

endpoint: string

id: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

endpoint: string

id: string

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<void>

Returns void

issueToken

Parameters

endpoint: string

id: string

scopes: string[]

Optional options: coreHttp.RequestOptionsBase

Returns Promise<Models.CommunicationIdentityIssueTokenResponse>

Parameters

endpoint: string

id: string

scopes: string[]

callback: coreHttp.ServiceCallback<CommunicationIdentityToken>

Returns void

Parameters

endpoint: string

id: string

scopes: string[]

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<CommunicationIdentityToken>

Returns void

update

Parameters

endpoint: string

id: string

Optional options: Models.CommunicationIdentityUpdateOptionalParams

Returns Promise<coreHttp.RestResponse>

Parameters

endpoint: string

id: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

endpoint: string

id: string

options: CommunicationIdentityUpdateOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void