API de la cuenta de JetBrains
Con la API de la cuenta de JetBrains, podrá gestionar automáticamente las licencias y las cuentas de usuario de su organización.
Puede utilizar la API para:
- Obtener detalles de la licencia
- Asignar o revocar licencias
- Transferir licencias entre equipos
- Crear o eliminar cuentas de usuario
Referencia de la API de la cuenta de JetBrains
Para obtener la lista completa de métodos de la API, consulte la Referencia de la API de la cuenta de JetBrains.
Las funciones de gestión de cuentas solo están disponibles para las organizaciones con un dominio verificado.
Niveles de acceso a la API
Su función en el perfil de la organización determina lo que puede hacer en la interfaz de usuario de su cuenta de JetBrains, a qué información puede acceder a través de la API y si se le permite modificarla.
| Función | Qué puede hacer en la interfaz de usuario de la cuenta de JetBrains | A qué puede acceder a través de la API | Nivel de acceso a la API |
|
Perfil de toda la organización |
Acceso total |
|
|
Su equipo |
Acceso total |
|
|
Espectadores y contactos principales |
Perfil de toda la organización |
Solo lectura |
Habilitar o deshabilitar la API
| 🔒 Permisos necesarios:administrador de la organización. |
Para habilitar la API:
- Inicie sesión en su cuenta de JetBrains.
- En el menú de la izquierda, haga clic en el nombre de su organización.
- Dans le menu qui s’affiche, sélectionnez Administration.
-
En la sección API, haga clic en Enable API.
Esto da acceso a la API a todos los administradores, espectadores y contactos principales. Podrán generar tokens de API personales y, dependiendo de su función, acceder al perfil de la organización o del equipo a través de la API.
Deshabilitar la API
Para deshabilitar la API, siga los pasos 1-3 de las instrucciones anteriores y, a continuación, haga clic en Disable API. Esto desactivará la API para todos los miembros de la organización.
La desactivación de la API bloquea el acceso al perfil de la organización a través de los métodos de la API, pero no invalida ningún token que ya se hubiera generado. Si habilita de nuevo la API más adelante, esos tokens seguirán funcionando. Consulte Token lifetime para obtener más detalles.
Gestionar los tokens de acceso a la API
Si su función en el perfil de la organización le otorga acceso a la API, puede generar un token de acceso personal y regenerarlo o eliminarlo cuando lo necesite. Los administradores de organizaciones y equipos también pueden gestionar los tokens generados por otros en su organización o equipo.
Gestionar su token de API personal
| 🔒 Permisos necesarios:administrador de la organización, administrador del equipoo contacto principal de facturación. |
Para utilizar la API, necesitará un token de acceso personal. Puede generar, regenerar.>regenerar o eliminar en cualquier momento. Su token está vinculado a su cuenta, por lo que cualquier solicitud API realizada con él estará vinculada a usted. Otros miembros de su organización con acceso a la API también pueden generar sus propios tokens.
Generar un token personal
- Asegúrese de que la API de la cuenta de JetBrains está activada en su organización.
- Inicie sesión en su cuenta de JetBrains.
- En el menú de la izquierda, seleccione una de las siguientes opciones, según su función:
- Si es administrador de una organización, espectador o contacto principal, haga clic en el nombre de su organización:
- Si es administrador de un equipo, haga clic en el nombre de su equipo:
- Si es administrador de una organización, espectador o contacto principal, haga clic en el nombre de su organización:
- En la sección API de la página de administración, haga clic en Generate token.
-
Cuando aparezca el diálogo, verá su token. Por motivos de seguridad, solo lo mostramos una vez, así que asegúrese de guardarlo en un lugar seguro antes de cerrar el diálogo.
No comparta su token con nadie. Si está en peligro, regenérelo o elimínelo inmediatamente.
Regenerar un token personal
Puede que necesite regenerar su token personal si:
- Ha perdido el acceso al actual.
- Su token se ha visto comprometido.
Para generar un nuevo token:
- Siga los pasos 1-3 de las instrucciones para generar un token personal.
- En la sección API de la página de administración, haga clic en Re-Generate Token.
- Cuando aparezca un cuadro de diálogo de confirmación, haga clic de nuevo en Re-Generate token.
- En el siguiente diálogo emergente, verá su nuevo token. Por motivos de seguridad, solo lo mostramos una vez, así que asegúrese de guardarlo en un lugar seguro antes de cerrar el diálogo.
Si regenera su token, el antiguo queda invalidado inmediatamente. Asegúrese de actualizar su token en cualquier aplicación que utilice la API.
Eliminar un token de acceso personal
Si ya no necesita acceder a la API, siga estos pasos para eliminar su token:
- Siga los pasos 1-3 de las instrucciones para generar su token.
- En la sección API de la página de administración, haga clic en Remove Token.
- Cuando aparezca un cuadro de diálogo de confirmación, pulse Remove Token de nuevo.
Gestionar los tokens API generados por otros
Como administrador de una organización o equipo, puede ver y revocar los tokens API generados por otros miembros de su organización o equipo.
Ver y revocar los tokens API de toda la organización
| 🔒 Permisos necesarios:administrador de la organización. |
- Siga los pasos 1-3 de las instrucciones anteriores para abrir la página de administración de la organización.
- En la página de administración, desplácese hasta Usuarios con acceso a licencias de empresa.
- En la columna API token, verá todas las personas de su organización que han generado un token.
- Para revocar un token, busque el usuario en la tabla y haga clic en Revoke.
Ver y revocar tokens API específicos de equipo
| 🔒 Permisos necesarios:administrador de la organizacióno administrador del equipo. |
- Siga los pasos 1-3 de las instrucciones para generar su token para abrir la página de administración del equipo.
- En la página de administración, desplácese hasta la sección Team Administration.
- En la columna API token, verá a todas las personas de su equipo que han generado un token.
- Para revocar un token, busque el usuario en la tabla y haga clic en Revoke.
Duración del token
Una vez emitidos, los tokens API de la cuenta de JetBrains tienen una vida útil indefinida.
Cada usuario recibe un token, aunque tenga varias funciones. A menos que lo regeneren o lo retiren, el token permanecerá activo mientras conserven al menos una función. Si pierden todas las funciones, la ficha se revoca automáticamente.
Si deshabilita la API y la vuelve a habilitar más tarde, los tokens generados previamente seguirán siendo válidos a menos que los elimine o los vuelva a generar.
Si su token personal se ve comprometido, regenérelo o elimínelo inmediatamente. Si el token de otra persona se ve comprometido, revóquelo.
Utilizar los métodos de la API
Consulte la Referencia de la API de la cuenta de JetBrains para obtener la lista completa de métodos disponibles. Tenga en cuenta que las funciones de gestión de cuentas solo están disponibles para las organizaciones con un dominio verificado.
Para utilizar los métodos de la API, necesitará dos parámetros:
1. Su IDE de cliente para X-Customer-Code
Su ID de cliente de JetBrains es un identificador único asociado a los pedidos y licencias de su organización. Lo encontrará en su cuenta de JetBrains.
Utilice este valor para el parámetro X-Customer-Code de su solicitud.
2. Su token de acceso para X-Api-Key
Siga los pasos anteriores para generar su token personal. Utilícelo para el parámetro X-Api-Key.