Person Directory Operations - Get Dynamic Person Group

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

Retrieve the information of a Dynamic Person Group, including its name and userData.
This API returns Dynamic Person Group information only, use Person Directory "Get Dynamic Person Group Persons" instead to retrieve person information under the Dynamic Person Group.

GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

URI Parameters

Name In Required Type Description
apiVersion
 path True

string

API Version
dynamicPersonGroupId
 path True

string

ID of the dynamic person group.

Regex pattern: ^[a-z0-9-_]+$
endpoint
 path True

string

uri

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

Responses

Name Type Description
200 OK

DynamicPersonGroup

A successful call returns the Dynamic Person Group's information.
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 DynamicPersonGroup

Sample request

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

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.