Azure Storage Accounts Local User Operation Group API

The LocalUserOperationGroup API from Azure Storage Accounts — 4 operation(s) for localuseroperationgroup.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers Local users list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username} Local users get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username} Local users create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username} Local users delete #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/listKeys Local users list keys #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/regeneratePassword Local users regenerate password #

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/azure-storage-accounts:azure-storage-accounts-localuseroperationgroup-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

azure-storage-accounts-localuseroperationgroup-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: StorageManagementClient Local User Operation Group API
  version: '2026-09-01'
  description: The Azure Storage Management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: LocalUserOperationGroup
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers
  : get:
      operationId: LocalUsers_List
      tags:
      - LocalUserOperationGroup
      description: List the local users associated with the storage account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: $maxpagesize
        in: query
        description: Optional, specifies the maximum number of local users that will be included in the list response.
        required: false
        schema:
          type: integer
          format: int32
          maximum: 5000
          minimum: 1
      - name: $filter
        in: query
        description: Optional. When specified, only local user names starting with the filter will be listed.
        required: false
        schema:
          type: string
      - name: $include
        in: query
        description: Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.
        required: false
        x-ms-enum:
          name: ListLocalUserIncludeParam
          modelAsString: true
          values:
          - name: nfsv3
            value: nfsv3
        schema:
          type: string
          enum:
          - nfsv3
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalUsers'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Local users list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}
  : get:
      operationId: LocalUsers_Get
      tags:
      - LocalUserOperationGroup
      description: Get the local user of the storage account by username.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: username
        in: path
        description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalUser'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Local users get
      x-summary-source: derived
    put:
      operationId: LocalUsers_CreateOrUpdate
      tags:
      - LocalUserOperationGroup
      description: Create or update the properties of a local user associated with the storage account. Properties for NFSv3 enablement and extended groups cannot be set with other properties.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: username
        in: path
        description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      responses:
        '200':
          description: Resource 'LocalUser' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalUser'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocalUser'
        description: The local user associated with a storage account.
        required: true
      summary: Local users create or update
      x-summary-source: derived
    delete:
      operationId: LocalUsers_Delete
      tags:
      - LocalUserOperationGroup
      description: Deletes the local user associated with the specified storage account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: username
        in: path
        description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Local users delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/listKeys
  : post:
      operationId: LocalUsers_ListKeys
      tags:
      - LocalUserOperationGroup
      description: List SSH authorized keys and shared key of the local user.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: username
        in: path
        description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalUserKeys'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Local users list keys
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/regeneratePassword
  : post:
      operationId: LocalUsers_RegeneratePassword
      tags:
      - LocalUserOperationGroup
      description: Regenerate the local user SSH password.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 3
          pattern: ^[a-z0-9]+$
      - name: username
        in: path
        description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalUserRegeneratePasswordResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Local users regenerate password
      x-summary-source: derived
components:
  schemas:
    ErrorResponseBody:
      type: object
      description: Error response body contract.
      properties:
        code:
          type: string
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        message:
          type: string
          description: A message describing the error, intended to be suitable for display in a user interface.
    LocalUserKeys:
      type: object
      description: The Storage Account Local User keys.
      properties:
        sshAuthorizedKeys:
          type: array
          description: Optional, local user ssh authorized keys for SFTP.
          items:
            $ref: '#/components/schemas/SshPublicKey'
          x-ms-identifiers: []
        sharedKey:
          type: string
          format: password
          description: Auto generated by the server for SMB authentication.
          readOnly: true
          x-ms-secret: true
    LocalUserProperties:
      type: object
      description: The Storage Account Local User properties.
      properties:
        permissionScopes:
          type: array
          description: The permission scopes of the local user.
          items:
            $ref: '#/components/schemas/PermissionScope'
          x-ms-identifiers: []
        homeDirectory:
          type: string
          description: Optional, local user home directory.
        sshAuthorizedKeys:
          type: array
          description: Optional, local user ssh authorized keys for SFTP.
          items:
            $ref: '#/components/schemas/SshPublicKey'
          x-ms-identifiers: []
        sid:
          type: string
          description: A unique Security Identifier that is generated by the server.
          readOnly: true
        hasSharedKey:
          type: boolean
          description: Indicates whether shared key exists. Set it to false to remove existing shared key.
        hasSshKey:
          type: boolean
          description: Indicates whether ssh key exists. Set it to false to remove existing SSH key.
        hasSshPassword:
          type: boolean
          description: Indicates whether ssh password exists. Set it to false to remove existing SSH password.
        userId:
          type: integer
          format: int32
          description: A unique Identifier that is generated by the server.
          readOnly: true
        groupId:
          type: integer
          format: int32
          description: An identifier for associating a group of users.
        allowAclAuthorization:
          type: boolean
          description: Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
        extendedGroups:
          type: array
          description: Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
          items:
            type: integer
            format: int32
        isNFSv3Enabled:
          type: boolean
          description: Indicates if the local user is enabled for access with NFSv3 protocol.
    PermissionScope:
      type: object
      properties:
        permissions:
          type: string
          description: 'The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).'
        service:
          type: string
          description: The service used by the local user, e.g. blob, file.
        resourceName:
          type: string
          description: The name of resource, normally the container name or the file share name, used by the local user.
      required:
      - permissions
      - service
      - resourceName
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    ErrorResponse:
      type: object
      description: An error response from the storage resource provider.
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseBody'
          description: Azure Storage Resource Provider error response body.
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    LocalUsers:
      type: object
      description: List of local users requested, and if paging is required, a URL to the next page of local users.
      properties:
        value:
          type: array
          description: The LocalUser items on this page
          items:
            $ref: '#/components/schemas/LocalUser'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    LocalUserRegeneratePasswordResult:
      type: object
      description: The secrets of Storage Account Local User.
      properties:
        sshPassword:
          type: string
          format: password
          description: Auto generated password by the server for SSH authentication if hasSshPassword is set to true on the creation of local user.
          readOnly: true
          x-ms-secret: true
    LocalUser:
      type: object
      description: The local user associated with the storage accounts.
      properties:
        properties:
          $ref: '#/components/schemas/LocalUserProperties'
          description: Storage account local user properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    SshPublicKey:
      type: object
      properties:
        description:
          type: string
          description: Optional. It is used to store the function/usage of the key
        key:
          type: string
          description: 'Ssh public key base64 encoded. The format should be: ''<keyType> <keyData>'', e.g. ssh-rsa AAAABBBB'
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.