API-metoder för grupphantering group-management-api-methods

Återställ API metoder för att hantera grupper, inklusive att skapa, uppdatera, lista och ta bort grupper.

Skapa en grupp create-group

En POST-metod för att skapa en ny användargrupp.

Begäran

POST /api/v1/groups/

Exempelbegärandebrödtext

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

Svar

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

Uppdatera en grupp update-group

En PUT-metod för att uppdatera en användargrupp.

Begäran

PUT /api/v1/groups/<groupId>

Exempelbegärandebrödtext

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

Svar

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

Listgrupper list-groups

En GET-metod för att lista användargrupper.

Begäran

GET /api/v1/groups/

Svar

[
  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }, ...
]

Ta bort en grupp delete-groups

En DELETE-metod som tar bort en användargrupp och alla medlemmar från den gruppen.

Begäran

DELETE /api/v1/groups/<groupId>

Returnerar 204 No Content om det lyckas. Om en konflikt skulle returnera 409 Conflict.

Ta bort grupper gruppvis delete-groups-bulk

En DELETE-metod för att ta bort flera grupper samtidigt och ta bort alla medlemmar från den gruppen.

Begäran

DELETE /api/v1/groups/bulk-delete

Returnerar 204 No Content om det lyckas. Om en konflikt skulle returnera 409 Conflict.

Visa alla behörigheter för en grupp list-permissions-group

En GET-metod för att lista behörighetsobjekten i en grupp.

Begäran

GET /api/v1/groups/{groupId}/permissions

Svar

[{
 "objectId" : 34,
 "objectType": "SEGMENT",
 "permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
 },

{
 "objectId" : "234",
 "objectType": "TRAIT",
 "permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
 },
 {
 "objectId" : 277,
 "objectType": "SEGMENT",
 "permissions": ["READ", "WRITE", "MAP_TO_MODELS"]
 }
]

Returnerar 400 Bad Request om gruppen inte är tillgänglig.

Ange behörigheter för en grupp set-permissions-group

En PUT-metod för att uppdatera gruppbehörigheter. Den här metoden skriver över de gamla behörigheterna med de nya behörigheterna.

Begäran

PUT /api/v1/groups/{groupId}/permissions/

Svar

[
  { "objectType" : "SEGMENT",
    "objectId" : 563,
    "permissions" : [ "READ", "WRITE"]
  },
  { "objectType" : "SEGMENT",
    "objectId" : 2363,
    "permissions" : [ "CREATE", "WRITE"]
  },
  { "objectType" : "TRAIT",
    "objectId" : 83498,
    "permissions" : [ "READ", "MAP_TO_SEGMENTS"]
  },
  { "objectType" : "DESTINATION",
    "objectId" : 304,
    "permissions" : [ "READ", "WRITE", "CREATE"]
  }
]

Exempelsvaret representerar den uppdaterade listan med behörighetsobjekt.

Returnerar 200 OK om det lyckas. Returnerar 400 om någon angiven behörighet är ogiltig. Kan även returnera 403 om objektet inte är tillgängligt för den inloggade användaren.