Usando cURL

cURL é uma ferramenta de linha de comando de código aberto para transferência de dados com sintaxe de URL, suportando vários protocolos, incluindo HTTP e HTTPS. Os exemplos neste documento usam o cURL para demonstrar como acessar a API REST dos domínios de identidade.

Usando o cURL para Acessar as APIs REST

  1. Instale o cURL. Consulte Etapa 2: Instalar cURL.

  2. Em uma janela de comando, defina a variável de ambiente cURL, CURL_CA_BUNDLE, como o local do pacote de certificados da CA local. Para obter informações sobre a verificação do certificado da CA usando o cURL, consulte: http://curl.haxx.se/docs/sslcerts.html.

    Nota

    Consulte Autorização para obter mais informações sobre requisitos de autorização e autenticação.

  3. Chame cURL e especifique uma ou mais das opções de linha de comando a seguir, conforme necessário, para direcionar sua execução.

    • -d, --data @file.json: Identifica o documento de solicitação, no formato JSON, na máquina local.
    • -F, --form @file.json: Identifica dados do formulário, no formato JSON, na máquina local.
    • -H, --header: Define o cabeçalho da solicitação no formato HEADER: VALUE. Os valores de cabeçalho dependem de qual ponto final você está acessando.
      • O tipo de conteúdo do documento de solicitação.

      • A autorização X-Client-ID, API_KEY_ID, para OAuth 2.0

      • A autorização X-Client-Secret, API_KEY_SECRET, para OAuth2.0

    • -i: Exibe informações do cabeçalho de resposta.
    • -X: Indica o método de solicitação HTTP (DELETE, GET, POST, PATCH ou PUT). Se essa opção for omitida, o padrão será GET.

O URL do Comando cURL

O URL usado com o comando cURL é o mesmo descrito em Enviar Solicitações, exceto que você deve substituir espaços no URL por caracteres de adição (+) e substituir aspas (") por %22.

Qualquer caractere em um URL que esteja fora do conjunto de caracteres ASCII, como espaços e aspas, deve ser codificado por URL. Por exemplo, o URL a seguir contém uma consulta de filtro que procura um usuário com um nome de usuário contendo jen ou começando com bj. Observe que ele contém espaços.

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

Para usar esse URL em uma linha de comando cURL, altere-o para:

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

Comando cURL para Enviar uma Solicitação 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 uma Solicitação 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"