Obtenir un groupe spécifique

Référence d'API pour la récupération d'informations sur un groupe spécifique par organisation et ID de groupe à l'aide du point de terminaison GET Group.

Renvoie des informations sur un groupe, en fonction de l'organisation et de l'ID de groupe.

Point de terminaison de l’API

GET https://{yourDomain}/identity/api/Group/{partitionGlobalId}/{groupId}

Étendues

Nécessite les étendues suivantes :

• PM.Group
• PM.Group.Read

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
partitionGlobalId (requis)	Chaîne de caractères (string)	L'ID de l'organisation contenant le groupe souhaité.
groupID (requis)	Chaîne de caractères (string)	L'ID du groupe que vous souhaitez récupérer.

Réponses

200 OK

Les informations de groupe indiquées sont renvoyées.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Votre {baseURL} est : https://{yourDomain}/identity
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {partitionGlobalId} est : 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Le {groupID} est : 2512

L’appel doit ressembler à l’exemple suivant (cURL) :

curl --location --request GET 'https://{yourDomain}/identity/api/Group/3fa85f64-5717-4562-b3fc-2c963f66afa6/2512' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Voici la réponse pour un appel réussi :

{
    "id": "2512",
    "name": "Automation Developers",
    "displayName": "Automation Developers",
    "type": 0,
    "creationTime": "2021-10-19T14:25:01.6574988",
    "lastModificationTime": "2021-10-19T14:25:01.6574988",
    "members": [
        {
            "objectType": "DirectoryUser",
            "firstName": "Albus",
            "lastName": "D",
            "jobTitle": "master",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Albus D",
            "source": "local",
            "identifier": "1787ef38-5933-4f2c-a67a-9c22cdb8e6a2",
            "name": "albus",
            "email": "[e-mail]"
        }
    ]
}