Introducción

Utilice el conector de flujos de trabajo de Okta de Secure Code Warrior para aprovechar los datos de los cursos y evaluaciones de Secure Code Warrior dentro de sus flujos. Por ejemplo, puede validar la competencia de seguridad de los desarrolladores mediante una evaluación antes de conceder acceso a repositorios de código confidenciales. Para obtener un caso de uso más detallado, consulte nuestra publicación de blog .

También puede utilizar el conector para automatizar la creación y eliminación de usuarios de la plataforma Secure Code Warrior. Las acciones de administración de usuarios requerirán una clave de API de administración.

 

NOTA:Esta función está pensada para ser utilizada solo en el entorno de producción (EE. UU. y la UE) y no se puede utilizar en el entorno de prueba.

 

Authorization

Requisitos previos

Generar una clave API

Se requiere una clave de API para conectarse a la API de Secure Code Warrior Platform y habilitar el uso del conector. Secure Code Warrior utiliza dos tipos de claves de API:

1. Las claves de la API de administración son de lectura y escritura y son necesarias para usar las tarjetas de acción Crear usuario y Eliminar usuario
2. Las claves de API de informes son de solo lectura y se pueden usar con todas las tarjetas de acción restantes

NOTA: Póngase en contacto con Secure Code Warrior para habilitar las claves de la API de administración.

 

Para generar una clave:

1. Inicie sesión en Secure Code Warrior con su cuenta de administrador de la empresa.
2. Vaya a Administración.
3. Haga clic en Más > Editar empresa.
4. En API de informes o API de administración, introduzca una etiqueta (por ejemplo, Clave de informes de flujos de trabajo de Okta) y haga clic en Generar clave. Aparecerá un cuadro de diálogo que contiene su clave API.
5. Copie la clave API en el portapapeles.

 

Configurar una conexión

Cuando agregue una tarjeta de acción Secure Code Warrior a un flujo por primera vez, se le pedirá que configure la conexión. Esto le permitirá conectarse a su organización de Secure Code Warrior, guardar su clave de API y reutilizar la conexión en nuevos flujos que incluyan tarjetas de acción de Secure Code Warrior. Para ello, siga los siguientes pasos:

1. Si aún no lo ha hecho, abra la consola Flujos de trabajo de Okta desde el panel de administración de Okta.
2. En la página Conexiones o en cualquier tarjeta de acción de Secure Code Warrior, haga clic en Nueva conexión.
3. Proporcione un apodo de conexión. Esto es útil si planeas crear varias conexiones para compartirlas con tu equipo.
4. Pegue su clave de API en Su clave de API de Secure Code Warrior.
5. Seleccione la región de instancia
6. Haga clic en Crear.

 

Cartas de acción

Comprobar la finalización de la evaluación para el usuario

Compruebe si un usuario ha superado la evaluación especificada. Tenga en cuenta que esto solo se puede usar para evaluaciones con un puntaje mínimo de aprobación establecido.

Opciones

No hay opciones

Entradas

Field	Description	Type	Required
Assessment ID	El identificador único de la evaluación para la que se va a comprobar la finalización.	String	True
Correo electrónico del usuario	La dirección de correo electrónico del usuario que se va a comprobar.	String	True

Salidas

Field	Descripción	Type
Evaluación completada	Valor booleano (verdadero/falso) que indica si el usuario ha superado la evaluación especificada.	True/False

 

Comprobar la finalización del curso para el usuario

Compruebe si un usuario ha completado el curso especificado.

Options

No hay opciones

Entradas

Field	Description	Type	Required
Course ID	El identificador único del curso que se va a comprobar.	String	True
Correo electrónico del usuario	La dirección de correo electrónico del usuario que se va a comprobar.	String	True

Salidas

Field	Descripción	Type
Curso completado	Un valor booleano (verdadero/falso) que indica si el usuario ha completado el curso especificado.	True/False

 

Lista de intentos de evaluación para el usuario

Obtenga una lista de los intentos de un usuario para una evaluación especificada. Se devolverá un máximo de 100 registros.

Opciones

Field	Description	Type	Required
Mostrar solo intentos pasados	Filtre los intentos de evaluación solo a aquellos en los que el usuario ha superado la puntuación mínima de aprobación. Los valores permitidos son Sí y No.	Dropdown	True

Entradas

Field	Description	Type	Required
Assessment ID	El identificador único de la evaluación para la que se van a recuperar los intentos.	String	True
Correo electrónico del usuario	La dirección de correo electrónico del usuario para el que se van a recuperar los intentos.	String	True

Salidas

Field	Descripción	Type
Intentos de evaluación	La lista de intentos del usuario para la evaluación especificada. Consulte la documentación de API para conocer la estructura de los objetos de la lista. Se devolverá un máximo de 100 registros.	List (Objeto)

 

Lista de inscripciones a cursos para el usuario

Obtenga una lista de las inscripciones de un usuario para un curso específico. Se devolverá un máximo de 100 registros.

Options

Field	Description	Type	Required
Mostrar solo las inscripciones de cursos aprobados	Filtre las inscripciones a los cursos solo para aquellos en los que el usuario haya completado el curso. Los valores permitidos son Sí y No.	Dropdown	True

Entradas

Field	Description	Type	Required
Course ID	El identificador único del curso para el que se recuperarán las inscripciones.	String	True
Correo electrónico del usuario	La dirección de correo electrónico del usuario para el que se van a recuperar las inscripciones al curso.	String	True

Salidas

Field	Descripción	Type
Inscripciones al curso	La lista de inscripciones del usuario para el curso especificado. Consulte la documentación de la API API para conocer la estructura de los objetos de la lista. Se devolverá un máximo de 100 registros.	List (Objeto)

 

Crear usuario

Se requiere una clave de API de administración. Agregue un nuevo usuario a la plataforma Secure Code Warrior.

Opciones

Field	Description	Type	Required
Enviar correos electrónicos de invitación	Envíe correos electrónicos de invitación y recordatorio para los usuarios creados. Los valores permitidos son Sí y No.	Dropdown	True

 

Entradas

Field	Description	Type	Required
Correo electrónico del usuario	La dirección de correo electrónico del usuario.	String	True
Rol de usuario	El rol del usuario. Los valores permitidos son Administrador de la empresa, Administrador de equipo y Desarrollador.	Dropdown	True
Team	El nombre de un equipo existente al que agregar el usuario. Este campo se ignora si se selecciona el rol de administrador de la empresa y es obligatorio para los roles de administrador de equipo y desarrollador.	String	False
Tags	Una lista de etiquetas para aplicar al usuario.	Lista de cadenas	False

Salidas

Field	Descripción	Type
Status Code	Resultado de la operación. El conector devuelve el código de estado HTTP e indica si la acción realizada por la tarjeta se realizó correctamente o no. Por ejemplo: Un código de estado 201 indica que el usuario se creó correctamente. Un error 401 o 403 indica que la solicitud no se procesó porque la clave de API no estaba autorizada. Un error 413 indica que la solicitud era demasiado grande. Un error 422 indica que se ha producido un error de procesamiento. Para obtener información detallada sobre los códigos de estado devueltos, consulte la documentación de la API API.	Number
Código de error detallado	Cuando esté disponible, se devolverá un código de error adicional además del código de estado HTTP que proporcionará información más detallada sobre lo que salió mal. Para obtener información detallada sobre los códigos de error detallados devueltos, consulte la documentación de la API API.	Number
Mensaje de error detallado	Cuando esté disponible, se devolverá un mensaje de error adicional con información más detallada sobre lo que salió mal. Para obtener información detallada sobre los mensajes de error detallados devueltos, consulte la documentación de la API API.	String

 

Eliminar usuario

Se requiere una clave de API de administración. Eliminar completamente a un usuario de la plataforma Secure Code Warrior. Esta operación es permanente y no se puede deshacer.

Opciones

No hay opciones

Entradas

Field	Description	Type	Required
Correo electrónico del usuario	La dirección de correo electrónico del usuario que se va a eliminar.	String	True

Salidas

Field	Descripción	Type
Status Code	Resultado de la operación. El conector devuelve el código de estado HTTP e indica si la acción realizada por la tarjeta se realizó correctamente o no. Por ejemplo: Un código de estado 200 indica que el usuario se eliminó correctamente. Un error 401 o 403 indica que la solicitud no se procesó porque la clave de API no estaba autorizada. Un error 422 indica que el correo electrónico de usuario proporcionado no es válido o no se pudo encontrar. Para obtener información detallada sobre los códigos de estado devueltos, consulte la documentación de la API API.	Number

 

Desactivar usuario

Se requiere una clave de API de administración. Deshabilite a un usuario para que ya no pueda acceder a la plataforma Secure Code Warrior.

Options

No hay opciones

Entradas

Field	Description	Type	Required
Correo electrónico del usuario	La dirección de correo electrónico del usuario que se va a eliminar.	String	True

Salidas

Field	Descripción	Type
Status Code	Resultado de la operación. El conector devuelve el código de estado HTTP e indica si la acción realizada por la tarjeta se realizó correctamente o no. Por ejemplo: Un código de estado 200 indica que el usuario se ha deshabilitado correctamente. Un error 401 o 403 indica que la solicitud no se procesó porque la clave de API no estaba autorizada. Un error 422 indica que el correo electrónico de usuario proporcionado no es válido o no se pudo encontrar. Para obtener información detallada sobre los códigos de estado devueltos, consulte la documentación de la API para Get User y Update User.	Number
Mensaje de error	Cuando esté disponible en el caso de un error, se devolverá un mensaje de error con información sobre lo que salió mal. Para obtener información detallada sobre los mensajes de error detallados devueltos, consulte la documentación de la API para Get User y Update User.

 

Acción de API personalizada

Utilice la acción de API personalizada para realizar una solicitud de API personalizada autenticada a la API de REST de Secure Code Warrior.

Opciones

Field	Description	Type	Required
Tipo de solicitud	El tipo de solicitud HTTP que se utilizará para la llamada a la API. Los valores permitidos son GET y POST.	Dropdown	True

Entradas

Field	Description	Type	Required
URL relativa	La dirección en el servidor web con el que está intentando interactuar. La URL es relativa, lo que significa que no es necesario especificar la ruta del protocolo, el host o la versión de la API (por ejemplo, https://portal-api.securecodewarrior.com/api/v2). El valor proporcionado debe comenzar con "/".	String	True
Headers	Un objeto JSON que representa los encabezados personalizados que se incluirán en la llamada API personalizada.	Object	True
Query	Un objeto JSON que representa los parámetros de consulta que se incluirán en la llamada API personalizada.	Object	True
Body	Un objeto JSON que representa el cuerpo de la solicitud HTTP que se incluirá en la llamada API personalizada.	Object	True

Salidas

Field	Description	Type
status_code	El código de estado de respuesta HTTP que indica si la llamada a la API se ha realizado correctamente o no. Consulte esta lista list para obtener más información sobre los posibles códigos de estado.	Number
headers	Un objeto JSON que representa los encabezados HTTP en la respuesta a la llamada API.	Object
body	Los datos devueltos por la solicitud de API personalizada. La estructura variará en función del punto de conexión de la API llamado. Consulte la documentación de la API de Secure Code Warrior Platform para obtener más información.	Object