Create New Role

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "custom_role",
  "displayName": "Custom Role",
  "description": "Custom role with specific permissions",
  "hasAdminPanelAccess": true,
  "permissions": [
    {
      "section": "user-management",
      "level": "admin"
    },
    {
      "section": "index-management",
      "level": "reader"
    }
  ],
  "canInteractWithAI": true,
  "canUseChat": true
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/roles"

payload = {
    "name": "custom_role",
    "displayName": "Custom Role",
    "description": "Custom role with specific permissions",
    "hasAdminPanelAccess": True,
    "permissions": [
        {
            "section": "user-management",
            "level": "admin"
        },
        {
            "section": "index-management",
            "level": "reader"
        }
    ],
    "canInteractWithAI": True,
    "canUseChat": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'custom_role',
    displayName: 'Custom Role',
    description: 'Custom role with specific permissions',
    hasAdminPanelAccess: true,
    permissions: [
      {section: 'user-management', level: 'admin'},
      {section: 'index-management', level: 'reader'}
    ],
    canInteractWithAI: true,
    canUseChat: true
  })
};

fetch('https://secureai.hiperai.ai/api/external/roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "Role created successfully",
  "role": {
    "id": "60a7c8f5e8b4f5001f7a8c26",
    "name": "custom_role",
    "displayName": "Custom Role",
    "description": "Custom role with specific permissions",
    "isSystem": false,
    "hasAdminPanelAccess": true,
    "permissions": [
      {
        "section": "user-management",
        "level": "admin"
      }
    ],
    "canInteractWithAI": true,
    "canUseChat": true,
    "userCount": 0,
    "createdBy": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

POST

roles

Create New Role

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "custom_role",
  "displayName": "Custom Role",
  "description": "Custom role with specific permissions",
  "hasAdminPanelAccess": true,
  "permissions": [
    {
      "section": "user-management",
      "level": "admin"
    },
    {
      "section": "index-management",
      "level": "reader"
    }
  ],
  "canInteractWithAI": true,
  "canUseChat": true
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/roles"

payload = {
    "name": "custom_role",
    "displayName": "Custom Role",
    "description": "Custom role with specific permissions",
    "hasAdminPanelAccess": True,
    "permissions": [
        {
            "section": "user-management",
            "level": "admin"
        },
        {
            "section": "index-management",
            "level": "reader"
        }
    ],
    "canInteractWithAI": True,
    "canUseChat": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'custom_role',
    displayName: 'Custom Role',
    description: 'Custom role with specific permissions',
    hasAdminPanelAccess: true,
    permissions: [
      {section: 'user-management', level: 'admin'},
      {section: 'index-management', level: 'reader'}
    ],
    canInteractWithAI: true,
    canUseChat: true
  })
};

fetch('https://secureai.hiperai.ai/api/external/roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "Role created successfully",
  "role": {
    "id": "60a7c8f5e8b4f5001f7a8c26",
    "name": "custom_role",
    "displayName": "Custom Role",
    "description": "Custom role with specific permissions",
    "isSystem": false,
    "hasAdminPanelAccess": true,
    "permissions": [
      {
        "section": "user-management",
        "level": "admin"
      }
    ],
    "canInteractWithAI": true,
    "canUseChat": true,
    "userCount": 0,
    "createdBy": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

Créer un rôle

Créez un nouveau rôle d’utilisateur personnalisé avec des autorisations spécifiques.

Point de terminaison

POST /roles

Description

Ce point de terminaison permet aux administrateurs de créer de nouveaux rôles d’utilisateur personnalisés. Les rôles personnalisés peuvent disposer d’autorisations spécifiques adaptées aux besoins de votre organisation. Vous pouvez spécifier le nom du rôle, la description et les autorisations lors de la création.

Authentification

Obligatoire : clé API avec privilèges d’administrateur

Authorization: Bearer sk-your-api-key-here

Corps de la demande

Paramètre	Tapez	Obligatoire	Descriptif
`name`	chaîne	Oui	Nom du rôle (identifiant du système)
`displayName`	chaîne	Oui	Nom de rôle lisible par l’homme
`description`	chaîne	Oui	Description du rôle objectif
`hasAdminPanelAccess`	booléen	Non	Indique si le rôle a accès au panneau d’administration (par défaut : false)
`permissions`	tableau	Non	Tableau d’objets d’autorisation
`canInteractWithAI`	booléen	Non	Indique si le rôle peut interagir avec l’IA (par défaut : vrai)
`canUseChat`	booléen	Non	Indique si le rôle peut utiliser le chat (par défaut : vrai)

Exemple de demande

{
  "name": "content_editor",
  "displayName": "Content Editor",
  "description": "Role for editing and managing content",
  "hasAdminPanelAccess": false,
  "permissions": [
    {
      "section": "user-management",
      "level": "reader"
    },
    {
      "section": "index-management",
      "level": "admin"
    }
  ],
  "canInteractWithAI": true,
  "canUseChat": true
}

Réponse réussie

Code d’état : 201 Created

{
  "success": true,
  "message": "Role created successfully",
  "role": {
    "id": "60a7c8f5e8b4f5001f7a8c26",
    "name": "content_editor",
    "displayName": "Content Editor",
    "description": "Role for editing and managing content",
    "isSystem": false,
    "hasAdminPanelAccess": false,
    "permissions": [
      {
        "section": "user-management",
        "level": "reader"
      },
      {
        "section": "index-management",
        "level": "admin"
      }
    ],
    "canInteractWithAI": true,
    "canUseChat": true,
    "userCount": 0,
    "createdBy": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "createdAt": "2024-01-20T15:30:00.000Z"
  }
}

Champs de réponse

Champ	Tapez	Descriptif
`success`	booléen	Indique si l’opération a réussi
`message`	chaîne	Message de réussite
`role`	objet	Objet de rôle créé
`role.id`	chaîne	Identificateur de rôle unique
`role.name`	chaîne	Nom du rôle
`role.displayName`	chaîne	Nom d’affichage du rôle
`role.description`	chaîne	Description du rôle
`role.isSystem`	booléen	S’il s’agit d’un rôle système
`role.hasAdminPanelAccess`	booléen	Indique si le rôle a accès au panneau d’administration
`role.permissions`	tableau	Tableau d’objets d’autorisation
`role.permissions[].section`	chaîne	Section autorisations
`role.permissions[].level`	chaîne	Niveau d’autorisation
`role.canInteractWithAI`	booléen	Si le rôle peut interagir avec l’IA
`role.canUseChat`	booléen	Indique si le rôle peut utiliser le chat
`role.userCount`	entier	Nombre d’utilisateurs avec ce rôle
`role.createdBy`	objet	Utilisateur qui a créé le rôle
`role.createdBy.id`	chaîne	ID utilisateur du créateur
`role.createdBy.name`	chaîne	Nom du créateur
`role.createdBy.email`	chaîne	E-mail du créateur
`role.createdAt`	chaîne	Horodatage de création

Exemple d’utilisation

###JavaScript

const createRole = async (roleData) => {
  const response = await fetch('https://{customer.name}.hiperai.ai/api/external/roles', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(roleData)
  });
  
  return await response.json();
};

// Example usage
const roleData = {
  name: "content_editor",
  displayName: "Content Editor",
  description: "Role for editing and managing content",
  hasAdminPanelAccess: false,
  permissions: [
    {
      section: "user-management",
      level: "reader"
    },
    {
      section: "index-management",
      level: "admin"
    }
  ],
  canInteractWithAI: true,
  canUseChat: true
};

const result = await createRole(roleData);
console.log('Created role:', result.role.id);

###Python

import requests

def create_role(role_data):
    url = "https://{customer.name}.hiperai.ai/api/external/roles"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here",
        "Content-Type": "application/json"
    }
    
    response = requests.post(url, headers=headers, json=role_data)
    return response.json()

# Example usage
role_data = {
    "name": "content_editor",
    "displayName": "Content Editor",
    "description": "Role for editing and managing content",
    "hasAdminPanelAccess": False,
    "permissions": [
        {
            "section": "user-management",
            "level": "reader"
        },
        {
            "section": "index-management",
            "level": "admin"
        }
    ],
    "canInteractWithAI": True,
    "canUseChat": True
}

result = create_role(role_data)
print("Created role:", result["role"]["id"])

boucle

curl -X POST "https://{customer.name}.hiperai.ai/api/external/roles" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "content_editor",
    "displayName": "Content Editor",
    "description": "Role for editing and managing content",
    "hasAdminPanelAccess": false,
    "permissions": [
      {
        "section": "user-management",
        "level": "reader"
      },
      {
        "section": "index-management",
        "level": "admin"
      }
    ],
    "canInteractWithAI": true,
    "canUseChat": true
  }'

Réponses d’erreur

400 Requête incorrecte

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Role name is required",
    "details": {
      "field": "name",
      "value": null
    }
  }
}

401 Non autorisé

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Interdit

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}

409 Conflit

{
  "success": false,
  "error": {
    "code": "ROLE_NAME_EXISTS",
    "message": "Role name already exists"
  }
}

429 Trop de demandes

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}

Sections d’autorisation disponibles

Rubrique	Descriptif
`home`	Accès au tableau de bord d’accueil
`user-management`	Opérations de gestion des utilisateurs
`index-management`	Opérations de gestion d’indices
`analytics`	Analyses et rapports
`group-management`	Opérations de gestion du groupe
`integrations`	Gestion de l’intégration
`services-status`	Surveillance de l’état des services
`settings`	Paramètres système
`announcements`	Gestion des annonces
`smltp-security`	Fonctionnalités de sécurité SMLTP

Niveaux d’autorisation disponibles

Niveau	Descriptif
`none`	Pas d’accès à la section
`reader`	Accès en lecture seule à la section
`admin`	Accès administratif complet à la section

Cas d’utilisation

Rôles personnalisés : créez des rôles adaptés aux besoins de votre organisation
Contrôle d’accès : définissez des autorisations spécifiques pour différents types d’utilisateurs
Sécurité : mettre en œuvre les principes d’accès du moindre privilège
Conformité : créez des rôles qui répondent aux exigences réglementaires
Intégration : définir des rôles pour l’intégration de systèmes tiers

Limites de taux

Par défaut : 50 requêtes par minute
Quotidien : 5 000 requêtes par jour
Mensuel : 150 000 demandes par mois

Remarques

Administrateur uniquement : ce point de terminaison nécessite des privilèges d’administrateur
Champs obligatoires : le nom, le displayName et la description sont obligatoires
Structure des autorisations : les autorisations sont des objets avec des propriétés de section et de niveau.
Rôles système : les rôles personnalisés ne sont jamais des rôles système
Réponse plate : la réponse n’est pas imbriquée sous l’objet de données
Informations sur le créateur : indique qui a créé le rôle
Nombre d’utilisateurs : commence à 0 pour les nouveaux rôles
Les noms de rôle doivent être uniques dans le système
Le rôle est immédiatement disponible pour l’affectation des utilisateurs

Autorisations

Authorization

string

header

requis

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Corps

application/json

name

string

requis

Role name (lowercase, no spaces)

Exemple:

"custom_role"

displayName

string

requis

Display name for the role

Exemple:

"Custom Role"

description

string

requis

Role description

Exemple:

"Custom role with specific permissions"

hasAdminPanelAccess

boolean

défaut:false

Whether role has admin panel access

Exemple:

true

permissions

object[]

Array of permission objects

Show child attributes

Exemple:

[
  {
    "section": "user-management",
    "level": "admin"
  },
  {
    "section": "index-management",
    "level": "reader"
  }
]

canInteractWithAI

boolean

défaut:true

Whether role can interact with AI

Exemple:

true

canUseChat

boolean

défaut:true

Whether role can use chat

Exemple:

true

Réponse

Role created successfully

success

boolean

Exemple:

true

message

string

Exemple:

"Role created successfully"

role

object

Show child attributes

Premiers Pas & Configuration

Modèles & Génération IA

Base de Connaissances & RAG

Sécurité, Guardrails & Audit

Utilisateurs & Accès (IAM)

Facturation, Quotas & Webhooks

Créer un rôle

Créer un rôle

Point de terminaison

Description

Authentification

Corps de la demande

Exemple de demande

Réponse réussie

Champs de réponse

Exemple d’utilisation

boucle

Réponses d’erreur

400 Requête incorrecte

401 Non autorisé

403 Interdit

409 Conflit

429 Trop de demandes

Sections d’autorisation disponibles

Niveaux d’autorisation disponibles

Cas d’utilisation

Limites de taux

Remarques

Autorisations

Corps

Réponse

​Créer un rôle

​Point de terminaison

​Description

​Authentification

​Corps de la demande

​Exemple de demande

​Réponse réussie

​Champs de réponse

​Exemple d’utilisation

​boucle

​Réponses d’erreur

​400 Requête incorrecte

​401 Non autorisé

​403 Interdit

​409 Conflit

​429 Trop de demandes

​Sections d’autorisation disponibles

​Niveaux d’autorisation disponibles

​Cas d’utilisation

​Limites de taux

​Remarques

Autorisations

Corps

Réponse

Créer un rôle

Point de terminaison

Description

Authentification

Corps de la demande

Exemple de demande

Réponse réussie

Champs de réponse

Exemple d’utilisation

boucle

Réponses d’erreur

400 Requête incorrecte

401 Non autorisé

403 Interdit

409 Conflit

429 Trop de demandes

Sections d’autorisation disponibles

Niveaux d’autorisation disponibles

Cas d’utilisation

Limites de taux

Remarques