Actualizar un rol

PUT

organizations

{organization_id}

roles

{role_id}

curl --request PUT \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/roles/{role_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Operador de organización",
  "permissions": [
    {
      "target_organization": "507f1f77bcf86cd799439011",
      "portal_permission": "organization_admin",
      "workspaces_permission": "admin_read_only",
      "analyzer_permission": "access",
      "target_reporting_groups": [
        "64f0c2a1b2d3e4f5060708c1",
        "64f0c2a1b2d3e4f5060708c2"
      ]
    }
  ]
}
'

{
  "id": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "permissions": [
    {
      "target_organization": "all",
      "target_reporting_groups": "all",
      "portal_permission": "admin",
      "workspaces_permission": "no_access",
      "analyzer_permission": "no_access"
    }
  ]
}

{
  "error": {
    "message": "Cuerpo de solicitud inválido",
    "code": "bad_request",
    "details": "permissions[0].target_organization debe ser una cadena hexadecimal en minusculas de 24 caracteres o el valor all"
  }
}

{
  "error": {
    "message": "No autorizado",
    "code": "unauthorized"
  }
}

{
  "error": {
    "message": "Rol no encontrado",
    "code": "not_found"
  }
}

{
  "error": {
    "message": "El nombre del rol ya existe",
    "code": "conflict",
    "details": "name ya está en uso dentro de esta organización"
  }
}

{
  "error": {
    "message": "Error interno del servidor",
    "code": "internal_error"
  }
}

Autorizaciones

Authorization

string

header

requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

organization_id

string

requerido

Identificador de organización.

Required string length: 24

Pattern: ^[0-9a-f]{24}$

role_id

string

requerido

Identificador de rol.

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Cuerpo

application/json

name

string

requerido

Nombre del rol de usuario.

Required string length: 1 - 120

permissions

object[]

requerido

Entradas completas de permisos que definen el estado final del rol.

Minimum array length: 1

Show child attributes

Respuesta

Rol actualizado correctamente.

string

requerido

Identificador del rol.

Required string length: 24

Pattern: ^[0-9a-f]{24}$

name

string

requerido

Nombre del rol.

organization_id

string

requerido

Identificador de la organización asociada a este rol.

Required string length: 24

Pattern: ^[0-9a-f]{24}$

created_at

string<date-time>

requerido

Marca de tiempo de creación del rol en formato ISO 8601.

created_by

string | null

requerido

Identificador del usuario que creó el rol.

Required string length: 24

Pattern: ^[0-9a-f]{24}$

permissions

object[] | null

Entradas de permisos configuradas para este rol.

Show child attributes

⌘I

curl --request PUT \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/roles/{role_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Operador de organización",
  "permissions": [
    {
      "target_organization": "507f1f77bcf86cd799439011",
      "portal_permission": "organization_admin",
      "workspaces_permission": "admin_read_only",
      "analyzer_permission": "access",
      "target_reporting_groups": [
        "64f0c2a1b2d3e4f5060708c1",
        "64f0c2a1b2d3e4f5060708c2"
      ]
    }
  ]
}
'

{
  "id": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "permissions": [
    {
      "target_organization": "all",
      "target_reporting_groups": "all",
      "portal_permission": "admin",
      "workspaces_permission": "no_access",
      "analyzer_permission": "no_access"
    }
  ]
}

{
  "error": {
    "message": "Cuerpo de solicitud inválido",
    "code": "bad_request",
    "details": "permissions[0].target_organization debe ser una cadena hexadecimal en minusculas de 24 caracteres o el valor all"
  }
}

{
  "error": {
    "message": "No autorizado",
    "code": "unauthorized"
  }
}

{
  "error": {
    "message": "Rol no encontrado",
    "code": "not_found"
  }
}

{
  "error": {
    "message": "El nombre del rol ya existe",
    "code": "conflict",
    "details": "name ya está en uso dentro de esta organización"
  }
}

{
  "error": {
    "message": "Error interno del servidor",
    "code": "internal_error"
  }
}

API Gen 2

Recursos API Gen 2 - v2

Recursos API Gen 2 - v1

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta