Autorisations d'accès aux listes

Restreindre la visibilité des éléments de liste par utilisateur ou groupe

Lister toutes les autorisations d'accès

get

Retourne toutes les autorisations d'accès définies dans l'instance.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Réponses

200

Toutes les autorisations d'accès

application/json

total_countintegerOptionnel

total_pagesintegerOptionnel

server_timeinteger · int64Optionnel

get/{app_short}/list/accessset

GET /{app_short}/list/accessset HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Toutes les autorisations d'accès

{
  "listaccesssets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "users": [
        "text"
      ],
      "groups": [],
      "root_id": 1,
      "lists": [
        1
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Créer une autorisation d'accès

post

Crée une nouvelle autorisation d'accès restreignant la visibilité d'éléments de liste.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

root_idintegerRequis

Identifiant du nœud racine de la liste

Corps

namestringRequis

Nom de l'autorisation d'accès

groupsinteger[]Optionnel

Identifiants des groupes à inclure

usersinteger[]Optionnel

Identifiants des utilisateurs à inclure

listsinteger[]Optionnel

Identifiants des éléments de liste à restreindre

Réponses

200

Autorisation d'accès créée

application/json

idstring · uuidOptionnel

post/{app_short}/list/{root_id}/accessset

POST /{app_short}/list/{root_id}/accessset HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "name": "text",
  "groups": [
    1
  ],
  "users": [
    1
  ],
  "lists": [
    1
  ]
}

200

Autorisation d'accès créée

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Récupérer les autorisations d'accès pour une liste et un utilisateur

get

Retourne les identifiants de toutes les autorisations définies pour une liste et un utilisateur donnés.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

user_idintegerRequis

Identifiant de l'utilisateur

Réponses

200

UUIDs des autorisations d'accès pour cet utilisateur et cette liste

application/json

string · uuid[]Optionnel

get/{app_short}/list/{list_id}/accessset/user/{user_id}

GET /{app_short}/list/{list_id}/accessset/user/{user_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

UUIDs des autorisations d'accès pour cet utilisateur et cette liste

[
  "123e4567-e89b-12d3-a456-426614174000"
]

Récupérer les détails d'une autorisation d'accès

get

Retourne les détails complets d'une autorisation d'accès.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

list_access_set_idstring · uuidRequis

Identifiant de l'autorisation d'accès (UUID)

Réponses

200

Détails complets de l'autorisation d'accès

application/json

Détails complets d'une autorisation d'accès

idstring · uuidOptionnel

namestringOptionnel

get/{app_short}/list/{list_id}/accessset/{list_access_set_id}

GET /{app_short}/list/{list_id}/accessset/{list_access_set_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Détails complets de l'autorisation d'accès

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "users": [
    {
      "id": 1,
      "email": "name@gmail.com",
      "first_name": "text",
      "last_name": "text",
      "groups": [],
      "system_groups": []
    }
  ],
  "groups": [],
  "root_id": {
    "id": 1,
    "name": "text",
    "level": 1,
    "position": 1,
    "has_image": true
  },
  "lists": [
    {
      "id": 1,
      "root_id": 1,
      "parent_id": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "name": "text",
      "has_image": true,
      "level": 1,
      "position": 1,
      "external_id": "text",
      "url": "text",
      "functionnal_status_color": "text"
    }
  ]
}

Supprimer une autorisation d'accès

delete

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

list_access_set_idstring · uuidRequis

Identifiant de l'autorisation d'accès (UUID)

Réponses

204

Autorisation d'accès supprimée

Aucun contenu

delete/{app_short}/list/{list_id}/accessset/{list_access_set_id}

DELETE /{app_short}/list/{list_id}/accessset/{list_access_set_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Autorisation d'accès supprimée

Aucun contenu

Générer les dépendances d'une autorisation d'accès

post

Recalcule immédiatement toutes les dépendances internes de l'autorisation d'accès. S'exécute automatiquement toutes les 5 minutes ; à appeler manuellement après des modifications en lot.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

list_access_set_idstring · uuidRequis

Identifiant de l'autorisation d'accès (UUID)

Réponses

200

Dépendances régénérées

Aucun contenu

post/{app_short}/list/{list_id}/accessset/{list_access_set_id}/generate

POST /{app_short}/list/{list_id}/accessset/{list_access_set_id}/generate HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Dépendances régénérées

Aucun contenu

Récupérer les entités d'une autorisation d'accès

get

Retourne les utilisateurs, groupes ou éléments de liste appartenant à l'autorisation. Utilisez users, groups ou lists comme valeur du paramètre entity.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

list_access_set_idstring · uuidRequis

Identifiant de l'autorisation d'accès (UUID)

entitystring · enumRequis

Type d'entité à retourner

Valeurs possibles:

Réponses

200

Tableau du type d'entité demandé

application/json

itemsanyOptionnel

get/{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}

GET /{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Tableau du type d'entité demandé

[]

Ajouter une entité à une autorisation d'accès

put

Ajoute un utilisateur, groupe ou élément de liste à l'autorisation d'accès.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

list_access_set_idstring · uuidRequis

Identifiant de l'autorisation d'accès (UUID)

entitystring · enumRequis

Type d'entité

Valeurs possibles:

entity_idintegerRequis

Identifiant de l'utilisateur, groupe ou élément à ajouter

Réponses

200

Entité ajoutée

Aucun contenu

put/{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id}

PUT /{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Entité ajoutée

Aucun contenu

Retirer une entité d'une autorisation d'accès

delete

Retire un utilisateur, groupe ou élément de liste de l'autorisation d'accès.

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

list_idintegerRequis

Identifiant de la liste

list_access_set_idstring · uuidRequis

Identifiant de l'autorisation d'accès (UUID)

entitystring · enumRequis

Type d'entité

Valeurs possibles:

entity_idintegerRequis

Identifiant de l'utilisateur, groupe ou élément à retirer

Réponses

204

Entité retirée

Aucun contenu

delete/{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id}

DELETE /{app_short}/list/{list_id}/accessset/{list_access_set_id}/{entity}/{entity_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Entité retirée

Aucun contenu

PrécédentListes SuivantTâches

Mis à jour il y a 1 mois

Ce contenu vous a-t-il été utile ?