azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.management.apimanagement.v2019_01_01.Users.yml

### YamlMime:JavaType
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users"
name: "Users"
nameWithType: "Users"
summary: "Type representing Users."
syntax: "public interface **Users**</br> extends <xref href=\"com.microsoft.azure.arm.collection.SupportsCreating?alt=com.microsoft.azure.arm.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserContract.DefinitionStages.Blank?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserContract.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.microsoft.azure.arm.model.HasInner?alt=com.microsoft.azure.arm.model.HasInner&text=HasInner\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UsersInner?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UsersInner&text=UsersInner\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.deleteAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.deleteAsync(String resourceGroupName, String serviceName, String userId, String ifMatch)"
  name: "deleteAsync(String resourceGroupName, String serviceName, String userId, String ifMatch)"
  nameWithType: "Users.deleteAsync(String resourceGroupName, String serviceName, String userId, String ifMatch)"
  summary: "Deletes specific user."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the resource group."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the API Management service."
    name: "serviceName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "User identifier. Must be unique in the current API Management service instance."
    name: "userId"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "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."
    name: "ifMatch"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Completable deleteAsync(String resourceGroupName, String serviceName, String userId, String ifMatch)"
  desc: "Deletes specific user."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.generateSsoUrlAsync(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.generateSsoUrlAsync(String resourceGroupName, String serviceName, String userId)"
  name: "generateSsoUrlAsync(String resourceGroupName, String serviceName, String userId)"
  nameWithType: "Users.generateSsoUrlAsync(String resourceGroupName, String serviceName, String userId)"
  summary: "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the resource group."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the API Management service."
    name: "serviceName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "User identifier. Must be unique in the current API Management service instance."
    name: "userId"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<GenerateSsoUrlResult> generateSsoUrlAsync(String resourceGroupName, String serviceName, String userId)"
  desc: "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.GenerateSsoUrlResult?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.GenerateSsoUrlResult&text=GenerateSsoUrlResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.getAsync(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.getAsync(String resourceGroupName, String serviceName, String userId)"
  name: "getAsync(String resourceGroupName, String serviceName, String userId)"
  nameWithType: "Users.getAsync(String resourceGroupName, String serviceName, String userId)"
  summary: "Gets the details of the user specified by its identifier."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the resource group."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the API Management service."
    name: "serviceName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "User identifier. Must be unique in the current API Management service instance."
    name: "userId"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<GroupUserContract> getAsync(String resourceGroupName, String serviceName, String userId)"
  desc: "Gets the details of the user specified by its identifier."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.GroupUserContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.GroupUserContract&text=GroupUserContract\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.getEntityTagAsync(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.getEntityTagAsync(String resourceGroupName, String serviceName, String userId)"
  name: "getEntityTagAsync(String resourceGroupName, String serviceName, String userId)"
  nameWithType: "Users.getEntityTagAsync(String resourceGroupName, String serviceName, String userId)"
  summary: "Gets the entity state (Etag) version of the user specified by its identifier."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the resource group."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the API Management service."
    name: "serviceName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "User identifier. Must be unique in the current API Management service instance."
    name: "userId"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Completable getEntityTagAsync(String resourceGroupName, String serviceName, String userId)"
  desc: "Gets the entity state (Etag) version of the user specified by its identifier."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.getSharedAccessTokenAsync(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.management.apimanagement.v2019_01_01.UserTokenParameters)"
  fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.getSharedAccessTokenAsync(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters)"
  name: "getSharedAccessTokenAsync(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters)"
  nameWithType: "Users.getSharedAccessTokenAsync(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters)"
  summary: "Gets the Shared Access Authorization Token for the User."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the resource group."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the API Management service."
    name: "serviceName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "User identifier. Must be unique in the current API Management service instance."
    name: "userId"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "Create Authorization Token parameters."
    name: "parameters"
    type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserTokenParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserTokenParameters&text=UserTokenParameters\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<UserTokenResult> getSharedAccessTokenAsync(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters)"
  desc: "Gets the Shared Access Authorization Token for the User."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserTokenResult?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserTokenResult&text=UserTokenResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.listByServiceAsync(java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.Users.listByServiceAsync(String resourceGroupName, String serviceName)"
  name: "listByServiceAsync(String resourceGroupName, String serviceName)"
  nameWithType: "Users.listByServiceAsync(String resourceGroupName, String serviceName)"
  summary: "Lists a collection of registered users in the specified service instance."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the resource group."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the API Management service."
    name: "serviceName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<GroupUserContract> listByServiceAsync(String resourceGroupName, String serviceName)"
  desc: "Lists a collection of registered users in the specified service instance."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.GroupUserContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.GroupUserContract&text=GroupUserContract\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Type representing Users."
implements:
- "<xref href=\"com.microsoft.azure.arm.collection.SupportsCreating?alt=com.microsoft.azure.arm.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.UserContract.DefinitionStages.Blank?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.UserContract.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.microsoft.azure.arm.model.HasInner?alt=com.microsoft.azure.arm.model.HasInner&text=HasInner\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UsersInner?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.UsersInner&text=UsersInner\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1