User interface
Interface representing a User.
Methods
Method Details
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Creates or Updates a user.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- UserCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Deletes specific user.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- UserDeleteOptionalParams
The options parameters.
Returns
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
- options
- UserGenerateSsoUrlOptionalParams
The options parameters.
Returns
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Gets the details of the user specified by its identifier.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
- options
- UserGetOptionalParams
The options parameters.
Returns
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the user specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- userId
-
string
User identifier. Must be unique in the current API Management service instance.
- options
- UserGetEntityTagOptionalParams
The options parameters.
Returns
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Gets the Shared Access Authorization Token for the User.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Lists a collection of registered users in the specified service instance.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- options
- UserListByServiceOptionalParams
The options parameters.
Returns
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Updates the details of the user specified by its identifier.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- UserUpdateOptionalParams
The options parameters.
Returns
Promise<UserUpdateResponse>