How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Persongroups API

The Persongroups API from Microsoft Azure — 8 operation(s) for persongroups.

Microsoft Azure Persongroups API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Person Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 16 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

16 operations 8 paths 13 schemas 3 DELETE6 GET3 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 16

Across 8 paths, the API surfaces 16 operations — 3 DELETE, 6 GET, 3 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Persongroups 16
POST
/persongroups/{personGroupId}/persons
Microsoft Azure Post Persongroups Persongroupid Persons
microsoftAzurePersongrouppersonCreate 1 param body → 200default
GET
/persongroups/{personGroupId}/persons
Microsoft Azure Get Persongroups Persongroupid Persons
microsoftAzurePersongrouppersonList 3 params → 200default
DELETE
/persongroups/{personGroupId}/persons/{personId}
Microsoft Azure Delete Persongroups Persongroupid Persons Personid
microsoftAzurePersongrouppersonDelete 2 params → 200default
GET
/persongroups/{personGroupId}/persons/{personId}
Microsoft Azure Get Persongroups Persongroupid Persons Personid
microsoftAzurePersongrouppersonGet 2 params → 200default
PATCH
/persongroups/{personGroupId}/persons/{personId}
Microsoft Azure Patch Persongroups Persongroupid Persons Personid
microsoftAzurePersongrouppersonUpdate 2 params body → 200default
DELETE
/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
Microsoft Azure Delete Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid
microsoftAzurePersongrouppersonDeleteface 3 params → 200default
GET
/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
Microsoft Azure Get Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid
microsoftAzurePersongrouppersonGetface 3 params → 200default
PATCH
/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
Microsoft Azure Patch Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid
microsoftAzurePersongrouppersonUpdateface 3 params body → 200default
PUT
/persongroups/{personGroupId}
Microsoft Azure Put Persongroups Persongroupid
microsoftAzurePersongroupCreate 1 param body → 200default
DELETE
/persongroups/{personGroupId}
Microsoft Azure Delete Persongroups Persongroupid
microsoftAzurePersongroupDelete 1 param → 200default
GET
/persongroups/{personGroupId}
Microsoft Azure Get Persongroups Persongroupid
microsoftAzurePersongroupGet 2 params → 200default
PATCH
/persongroups/{personGroupId}
Microsoft Azure Patch Persongroups Persongroupid
microsoftAzurePersongroupUpdate 1 param body → 200default
GET
/persongroups/{personGroupId}/training
Microsoft Azure Get Persongroups Persongroupid Training
microsoftAzurePersongroupGettrainingstatus 1 param → 200default
GET
/persongroups
Microsoft Azure Get Persongroups
microsoftAzurePersongroupList 3 params → 200default
POST
/persongroups/{personGroupId}/train
Microsoft Azure Post Persongroups Persongroupid Train
microsoftAzurePersongroupTrain 1 param → 202default
POST
/persongroups/{personGroupId}/persons/{personId}/persistedfaces
Microsoft Azure Post Persongroups Persongroupid Persons Personid Persistedfaces
microsoftAzurePersongrouppersonAddfacefromurl 6 params → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are TrainingStatus (5 properties), PersonGroup (4 properties), Error (2 properties), PersistedFace (2 properties). Each schema is shown below with its type and property counts.

APIError
object
Error information returned by the API
1 property
Error
object
Error body.
2 properties
PersonGroup
object
Person group object.
4 properties 2 required
NameAndUserDataContractForCreation
object
A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.
2 properties 1 required
TrainingStatus
object
Training status object.
5 properties 2 required
UpdateFaceRequest
object
Request to update face data.
1 property
Persons
array
An array of Persons.
RecognitionModel
string
Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)Perso…
MetaDataContract
object
A combination of user defined name and user specified data and recognition model name for largePersonGroup/personGroup, and largeFaceList/faceList.
1 property
NameAndUserDataContract
object
A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.
2 properties
PersistedFace
object
PersonFace object.
2 properties 1 required
PersonGroups
array
An array of person groups.
Person
object
Person object.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-persongroups-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Persongroups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.