Static Sites - List Static Site Users

Service:

App Service

API Version:

2023-12-01

Description for Gets the list of users of a static site.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
authprovider	path	True	string	The auth provider for the users.
name	path	True	string	Name of the static site.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	StaticSiteUserCollection	OK.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List users for a static site

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/authproviders/all/listUsers?api-version=2023-12-01

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/authproviders/all/users/1234",
      "properties": {
        "provider": "aad",
        "userId": "1234",
        "displayName": "username",
        "roles": "admin,anonymous,authenticated"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
StaticSiteUserARMResource	Static Site User ARM resource.
StaticSiteUserCollection	Collection of static site custom users.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

StaticSiteUserARMResource

Static Site User ARM resource.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.displayName	string	The display name for the static site user.
properties.provider	string	The identity provider for the static site user.
properties.roles	string	The roles for the static site user, in free-form string format
properties.userId	string	The user id for the static site user.
type	string	Resource type.

StaticSiteUserCollection

Collection of static site custom users.

Name	Type	Description
nextLink	string	Link to next page of resources.
value	StaticSiteUserARMResource[]	Collection of resources.