Amazon License Manager License Manager User API

The License Manager User API from Amazon License Manager — 6 operation(s) for license manager user.

GitHub OpenAPI

Operations 6

POST /user/AssociateUser Associate User #
POST /user/DisassociateUser Disassociate User #
POST /user/ListProductSubscriptions List Product Subscriptions #
POST /user/ListUserAssociations List User Associations #
POST /user/StartProductSubscription Start Product Subscription #
POST /user/StopProductSubscription Stop Product Subscription #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-license-manager:amazon-license-manager-user-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-license-manager-user-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS License Manager User API
  version: '2018-08-01'
  description: Generated from AWS's published Smithy model for AWS License Manager. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://license-manager-user-subscriptions.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /user/AssociateUser:
    post:
      operationId: AssociateUser
      summary: Associate User
      description: Associates the user to an EC2 instance to utilize user-based subscriptions. Your estimated bill for charges
        on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked
        as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges
        in the Amazon Web Services Billing User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateUserResponse'
        '400':
          description: AccessDeniedException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsAccessDeniedException'
        '500':
          description: ConflictException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateUserRequest'
      tags:
      - User
  /user/DisassociateUser:
    post:
      operationId: DisassociateUser
      summary: Disassociate User
      description: Disassociates the user from an EC2 instance providing user-based subscriptions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisassociateUserResponse'
        '400':
          description: AccessDeniedException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsAccessDeniedException'
        '500':
          description: ConflictException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisassociateUserRequest'
      tags:
      - User
  /user/ListProductSubscriptions:
    post:
      operationId: ListProductSubscriptions
      summary: List Product Subscriptions
      description: Lists the user-based subscription products available from an identity provider.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProductSubscriptionsResponse'
        '400':
          description: AccessDeniedException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsAccessDeniedException'
        '500':
          description: ConflictException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListProductSubscriptionsRequest'
      tags:
      - User
  /user/ListUserAssociations:
    post:
      operationId: ListUserAssociations
      summary: List User Associations
      description: Lists user associations for an identity provider.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUserAssociationsResponse'
        '400':
          description: AccessDeniedException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsAccessDeniedException'
        '500':
          description: ConflictException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListUserAssociationsRequest'
      tags:
      - User
  /user/StartProductSubscription:
    post:
      operationId: StartProductSubscription
      summary: Start Product Subscription
      description: Starts a product subscription for a user with the specified identity provider. Your estimated bill for
        charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed
        (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly
        charges in the Amazon Web Services Billing User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartProductSubscriptionResponse'
        '400':
          description: AccessDeniedException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsAccessDeniedException'
        '500':
          description: ConflictException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartProductSubscriptionRequest'
      tags:
      - User
  /user/StopProductSubscription:
    post:
      operationId: StopProductSubscription
      summary: Stop Product Subscription
      description: Stops a product subscription for a user with the specified identity provider.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopProductSubscriptionResponse'
        '400':
          description: AccessDeniedException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsAccessDeniedException'
        '500':
          description: ConflictException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerUserSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopProductSubscriptionRequest'
      tags:
      - User
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: license-manager-user-subscriptions
  schemas:
    ActiveDirectoryIdentityProvider:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The directory ID for an Active Directory identity provider.
        ActiveDirectorySettings:
          $ref: '#/components/schemas/ActiveDirectorySettings'
        ActiveDirectoryType:
          type: string
          description: The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed
            Active Directory.
        IsSharedActiveDirectory:
          type: boolean
          description: Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default
            value is false.
    ActiveDirectorySettings:
      type: object
      properties:
        DomainName:
          type: string
          description: The domain name for the Active Directory.
        DomainIpv4List:
          type: array
          items:
            type: string
          description: A list of domain IPv4 addresses that are used for the Active Directory.
        DomainIpv6List:
          type: array
          items:
            type: string
          description: A list of domain IPv6 addresses that are used for the Active Directory.
        DomainCredentialsProvider:
          $ref: '#/components/schemas/CredentialsProvider'
        DomainNetworkSettings:
          $ref: '#/components/schemas/DomainNetworkSettings'
    AssociateUserRequest:
      type: object
      properties:
        Username:
          type: string
          description: The user name from the identity provider.
        InstanceId:
          type: string
          description: The ID of the EC2 instance that provides the user-based subscription.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        Domain:
          type: string
          description: The domain name of the Active Directory that contains information for the user to associate.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that apply for the user association.
      required:
      - Username
      - InstanceId
      - IdentityProvider
    AssociateUserResponse:
      type: object
      properties:
        InstanceUserSummary:
          $ref: '#/components/schemas/InstanceUserSummary'
      required:
      - InstanceUserSummary
    CredentialsProvider:
      type: object
      properties:
        SecretsManagerCredentialsProvider:
          $ref: '#/components/schemas/SecretsManagerCredentialsProvider'
      description: Exactly one member is set.
    DisassociateUserRequest:
      type: object
      properties:
        Username:
          type: string
          description: The user name from the Active Directory identity provider for the user.
        InstanceId:
          type: string
          description: The ID of the EC2 instance which provides user-based subscriptions.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        InstanceUserArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.
        Domain:
          type: string
          description: The domain name of the Active Directory that contains information for the user to disassociate.
    DisassociateUserResponse:
      type: object
      properties:
        InstanceUserSummary:
          $ref: '#/components/schemas/InstanceUserSummary'
      required:
      - InstanceUserSummary
    DomainNetworkSettings:
      type: object
      properties:
        Subnets:
          type: array
          items:
            type: string
          description: Contains a list of subnets that apply for the Active Directory domain.
      required:
      - Subnets
    IdentityProvider:
      type: object
      properties:
        ActiveDirectoryIdentityProvider:
          $ref: '#/components/schemas/ActiveDirectoryIdentityProvider'
      description: Exactly one member is set.
    InstanceUserSummary:
      type: object
      properties:
        Username:
          type: string
          description: The user name from the identity provider for the user.
        InstanceId:
          type: string
          description: The ID of the EC2 instance that provides user-based subscriptions.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        Status:
          type: string
          description: The status of a user associated with an EC2 instance.
        InstanceUserArn:
          type: string
          description: The Amazon Resource Name (ARN) that identifies the instance user.
        StatusMessage:
          type: string
          description: The status message for users of an EC2 instance.
        Domain:
          type: string
          description: The domain name of the Active Directory that contains the user information for the product subscription.
        AssociationDate:
          type: string
          description: The date a user was associated with an EC2 instance.
        DisassociationDate:
          type: string
          description: The date a user was disassociated from an EC2 instance.
      required:
      - Username
      - InstanceId
      - IdentityProvider
      - Status
    LicenseManagerUserSubscriptionsAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    LicenseManagerUserSubscriptionsConflictException:
      type: object
      properties:
        message:
          type: string
    LicenseManagerUserSubscriptionsFilter:
      type: object
      properties:
        Attribute:
          type: string
          description: The name of an attribute to use as a filter.
        Operation:
          type: string
          description: The type of search (For example, eq, geq, leq)
        Value:
          type: string
          description: Value of the filter.
    LicenseManagerUserSubscriptionsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ListProductSubscriptionsRequest:
      type: object
      properties:
        Product:
          type: string
          description: 'The name of the user-based subscription product. Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL
            | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES'
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        MaxResults:
          type: integer
          description: The maximum number of results to return from a single request.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/LicenseManagerUserSubscriptionsFilter'
          description: 'You can use the following filters to streamline results: Status Username Domain'
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
      required:
      - IdentityProvider
    ListProductSubscriptionsResponse:
      type: object
      properties:
        ProductUserSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ProductUserSummary'
          description: Metadata that describes the list product subscriptions operation.
        NextToken:
          type: string
          description: The next token used for paginated responses. When this field isn't empty, there are additional elements
            that the service hasn't included in this request. Use this token with the next request to retrieve additional
            objects.
    ListUserAssociationsRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The ID of the EC2 instance, which provides user-based subscriptions.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        MaxResults:
          type: integer
          description: The maximum number of results to return from a single request.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/LicenseManagerUserSubscriptionsFilter'
          description: 'You can use the following filters to streamline results: Status Username Domain'
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
      required:
      - InstanceId
      - IdentityProvider
    ListUserAssociationsResponse:
      type: object
      properties:
        InstanceUserSummaries:
          type: array
          items:
            $ref: '#/components/schemas/InstanceUserSummary'
          description: Metadata that describes the list user association operation.
        NextToken:
          type: string
          description: The next token used for paginated responses. When this field isn't empty, there are additional elements
            that the service hasn't included in this request. Use this token with the next request to retrieve additional
            objects.
    ProductUserSummary:
      type: object
      properties:
        Username:
          type: string
          description: The user name from the identity provider for this product user.
        Product:
          type: string
          description: The name of the user-based subscription product.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        Status:
          type: string
          description: The status of a product for this user.
        ProductUserArn:
          type: string
          description: The Amazon Resource Name (ARN) for this product user.
        StatusMessage:
          type: string
          description: The status message for a product for this user.
        Domain:
          type: string
          description: The domain name of the Active Directory that contains the user information for the product subscription.
        SubscriptionStartDate:
          type: string
          description: The start date of a subscription.
        SubscriptionEndDate:
          type: string
          description: The end date of a subscription.
        LicenseExpirationDate:
          type: string
          description: The expiration date of the license associated with this subscription, in ISO 8601 UTC format (for example,
            2025-03-15T00:00:00Z). This field applies only to subscriptions that use license server endpoints, such as Remote
            Desktop Services (RDS) Subscriber Access License (SAL). It returns null for products that don't use license-based
            subscriptions.
      required:
      - Username
      - Product
      - IdentityProvider
      - Status
    SecretsManagerCredentialsProvider:
      type: object
      properties:
        SecretId:
          type: string
          description: The ID of the Secrets Manager secret that contains credentials.
    StartProductSubscriptionRequest:
      type: object
      properties:
        Username:
          type: string
          description: The user name from the identity provider of the user.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        Product:
          type: string
          description: 'The name of the user-based subscription product. Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL
            | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES'
        Domain:
          type: string
          description: The domain name of the Active Directory that contains the user for whom to start the product subscription.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that apply to the product subscription.
      required:
      - Username
      - IdentityProvider
      - Product
    StartProductSubscriptionResponse:
      type: object
      properties:
        ProductUserSummary:
          $ref: '#/components/schemas/ProductUserSummary'
      required:
      - ProductUserSummary
    StopProductSubscriptionRequest:
      type: object
      properties:
        Username:
          type: string
          description: The user name from the identity provider for the user.
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        Product:
          type: string
          description: 'The name of the user-based subscription product. Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL
            | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES'
        ProductUserArn:
          type: string
          description: The Amazon Resource Name (ARN) of the product user.
        Domain:
          type: string
          description: The domain name of the Active Directory that contains the user for whom to stop the product subscription.
    StopProductSubscriptionResponse:
      type: object
      properties:
        ProductUserSummary:
          $ref: '#/components/schemas/ProductUserSummary'
      required:
      - ProductUserSummary
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/license-manager-user-subscriptions/service/2018-05-10/license-manager-user-subscriptions-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)