User | @azure/arm-apimanagement

Interface representing a User.

Hierarchy

User

Implemented by

UserImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>

- Defined in operationsInterfaces/user.ts:79
Creates or Updates a user.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- parameters: UserCreateParameters
  
  Create or update parameters.
- Optional options: UserCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<UserCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/user.ts:113
Deletes specific user.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- Optional options: UserDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

generateSsoUrl

generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<UserGenerateSsoUrlResponse>

- Defined in operationsInterfaces/user.ts:128
Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- Optional options: UserGenerateSsoUrlOptionalParams
  
  The options parameters.
Returns Promise<UserGenerateSsoUrlResponse>

get

get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>

- Defined in operationsInterfaces/user.ts:65
Gets the details of the user specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- Optional options: UserGetOptionalParams
  
  The options parameters.
Returns Promise<UserGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagResponse>

- Defined in operationsInterfaces/user.ts:52
Gets the entity state (Etag) version of the user specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- Optional options: UserGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<UserGetEntityTagResponse>

getSharedAccessToken

getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserGetSharedAccessTokenResponse>

- Defined in operationsInterfaces/user.ts:142
Gets the Shared Access Authorization Token for the User.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- parameters: UserTokenParameters
  
  Create Authorization Token parameters.
- Optional options: UserGetSharedAccessTokenOptionalParams
  
  The options parameters.
Returns Promise<UserGetSharedAccessTokenResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract>

- Defined in operationsInterfaces/user.ts:40
Lists a collection of registered users in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: UserListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<UserContract>

update

update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>

- Defined in operationsInterfaces/user.ts:96
Updates the details of the user specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- userId: string
  
  User identifier. Must be unique in the current API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters: UserUpdateParameters
  
  Update parameters.
- Optional options: UserUpdateOptionalParams
  
  The options parameters.
Returns Promise<UserUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

userId: string

parameters: UserCreateParameters

Optional options: UserCreateOrUpdateOptionalParams

Returns Promise<UserCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

userId: string

ifMatch: string

Optional options: UserDeleteOptionalParams

Returns Promise<void>

generateSsoUrl

Parameters

resourceGroupName: string

serviceName: string

userId: string

Optional options: UserGenerateSsoUrlOptionalParams

Returns Promise<UserGenerateSsoUrlResponse>

get

Parameters

resourceGroupName: string

serviceName: string

userId: string

Optional options: UserGetOptionalParams

Returns Promise<UserGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

userId: string

Optional options: UserGetEntityTagOptionalParams

Returns Promise<UserGetEntityTagResponse>

getSharedAccessToken

Parameters

resourceGroupName: string

serviceName: string

userId: string

parameters: UserTokenParameters

Optional options: UserGetSharedAccessTokenOptionalParams

Returns Promise<UserGetSharedAccessTokenResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: UserListByServiceOptionalParams

Returns PagedAsyncIterableIterator<UserContract>

update

Parameters

resourceGroupName: string

serviceName: string

userId: string

ifMatch: string

parameters: UserUpdateParameters

Optional options: UserUpdateOptionalParams

Returns Promise<UserUpdateResponse>