Uso de cURL

cURL es una herramienta de línea de comandos de código abierto para transferir datos con sintaxis de URL, que admite varios protocolos, incluidos HTTP y HTTPS. En los ejemplos de este documento se utiliza cURL para demostrar cómo acceder a la API de REST de los dominios de identidad.

Uso de cURL para acceder a las API de REST

  1. Instale cURL. Consulte Paso 2: Instalación de cURL.

  2. En una ventana de comandos, defina la variable de entorno cURL, CURL_CA_BUNDLE, en la ubicación del grupo de certificados de CA local. Para obtener información sobre la verificación de certificados de CA mediante cURL, consulte: http://curl.haxx.se/docs/sslcerts.html.

    Nota

    Consulte Autorización para obtener más información sobre los requisitos de autorización y autenticación.

  3. Llame a cURL y especifique una o más de las siguientes opciones de línea de comandos, según sea necesario, para dirigir su ejecución.

    • -d, --data @file.json: identifica el documento de solicitud, en formato JSON, en la máquina local.
    • -F, --form @file.json: identifica los datos del formulario, en formato JSON, en la máquina local.
    • -H, --header: define la cabecera de solicitud con el formato HEADER: VALUE. Los valores de cabecera dependen del punto final al que esté accediendo.
      • Tipo de contenido del documento de solicitud.

      • La autorización X-Client-ID, API_KEY_ID, para OAuth 2.0

      • Autorización X-Client-Secret, API_KEY_SECRET, para OAuth2.0

    • -i: muestra la información de cabecera de respuesta.
    • -X: indica el método de solicitud HTTP (DELETE, GET, POST, PATCH o PUT). Si se omite esta opción, el valor por defecto es GET.

URL del comando cURL

La URL utilizada con el comando cURL es la misma que la descrita en Send Requests, excepto que debe sustituir espacios en la URL por caracteres más (+) y sustituir comillas (") por %22.

Cualquier carácter de una URL que esté fuera del juego de caracteres ASCII, como espacios y comillas, debe estar codificado en la URL. Por ejemplo, la siguiente URL contiene una consulta de filtro que busca un usuario con un nombre de usuario que contenga jen o que empiece por bj. Tenga en cuenta que contiene espacios.

https://<domainURL>/admin/v1/Users?filter=userName co "jen" or userName sw "bj"

Para utilizar esta URL en una línea de comandos de cURL, debe cambiarla a:

https://<domainURL>/admin/v1/Users?filter=userName+co+%22jen%22+or+userName+sw+%22bj%22

Comando cURL para enviar una solicitud GET

curl 
-H "Accept: application/scim+json" 
-H "Authorization: Bearer <really long access token here>" 
-G https://<domainURL>/admin/v1/Groups?filter=displayName+co+%22admin%22"

Comando cURL para enviar una solicitud POST

curl 
-H "Content-Type: application/scim+json" 
-H "Authorization: Bearer <really long access token here>" 
-d '{ "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"bjensen@example.com","name": {"familyName":"Jensen","givenName": "Barbara","middleName": "Jane"},"emails": [{"value": "bjensen@example.com","type": "work","primary": true}]}' "https://<domainURL>/admin/v1/Users"