Share via

Person Directory Operations - Get Dynamic Person Groups

  • Reference
Service:
Azure AI Services
API Version:
v1.2-preview.1

List all existing Dynamic Person Groups by dynamicPersonGroupId along with name and userData.
Dynamic Person Groups are stored in alphabetical order of dynamicPersonGroupId.

    • "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
    • "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.

Tip

  • For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
    • "start=&top=" will return all 5 items.
    • "start=&top=2" will return "itemId1", "itemId2".
    • "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".
GET {endpoint}/face/{apiVersion}/dynamicpersongroups
With optional parameters: 
GET {endpoint}/face/{apiVersion}/dynamicpersongroups?start={start}&top={top}

URI Parameters

Name In Required Type Description
apiVersion
 path True

string

API Version
endpoint
 path True

string

uri

Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).
start
 query

string

List resources greater than the "start". It contains no more than 64 characters. Default is empty.
top
 query

integer

int32

The number of items to list, ranging in [1, 1000]. Default is 1000.

Responses

Name Type Description
200 OK

DynamicPersonGroup[]

A successful call returns an array of Dynamic Person Groups and their information (dynamicPersonGroupId, name and userData).
Other Status Codes

FaceErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Get DynamicPersonGroups

Sample request

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

Sample response

Status code:
200 
[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Definitions

Name Description
DynamicPersonGroup

A container that references Person Directory "Create Person".
FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

A response containing error details.

DynamicPersonGroup

A container that references Person Directory "Create Person".

Name Type Description
dynamicPersonGroupId

string

ID of the dynamic person group.
name

string

User defined name, maximum length is 128.
userData

string

Optional user defined data. Length should not exceed 16K.

FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name Type Description
code

string

One of a server-defined set of error codes.
message

string

A human-readable representation of the error.

FaceErrorResponse

A response containing error details.

Name Type Description
error

FaceError

The error object.