Edge 관리 API와 함께 외부 IDP 사용

기본 인증은 Edge 관리 API를 호출할 때 인증하는 한 가지 방법입니다. 예를 들어 Edge 관리 API에 다음 curl 요청을 수행하여 조직에 대한 정보에 액세스할 수 있습니다.

curl -u USER_NAME:PASSWORD https://MS_IP_DNS:8080/v1/organizations/ORG_NAME

이 예시에서는 curl -u 옵션을 사용하여 기본 사용자 인증 정보를 전달합니다. 또는 다음 예시와 같이 Bearer 헤더에 OAuth2 토큰을 전달하여 Edge 관리 API를 호출할 수 있습니다.

curl -H "Authorization: Bearer ACCESS_TOKEN" https://MS_IP_DNS:8080/v1/organizations/ORG_NAME

인증을 위해 외부 IDP를 사용 설정한 후 필요에 따라 기본 인증을 사용 중지할 수 있습니다. 기본 인증을 사용 중지하면 기본 인증을 지원하는 Edge 관리 API 호출을 사용하는 모든 스크립트 (예: Maven, 셸, apigeetool)가 더 이상 작동하지 않습니다. Bearer 헤더에 OAuth2 액세스 토큰을 전달하려면 기본 인증을 사용하는 모든 API 호출 및 스크립트를 업데이트해야 합니다.

get_token으로 토큰 가져오기 및 갱신

get_token 유틸리티는 기본 인증 사용자 인증 정보 (경우에 따라 비밀번호)를 OAuth2 액세스 및 갱신 토큰으로 교환합니다. get_token 유틸리티는 사용자 인증 정보를 수락하고 유효한 액세스 토큰을 반환합니다. 토큰을 새로고침할 수 있으면 유틸리티가 새로고침하여 반환합니다. 갱신 토큰이 만료되면 사용자 인증 정보를 요청하는 메시지가 표시됩니다.

get_token 유틸리티는 필요할 때 사용할 수 있도록 디스크에 토큰을 저장합니다. 또한 유효한 액세스 토큰을 stdout에 출력합니다. 여기에서 Postman과 같은 브라우저 확장 프로그램을 사용하거나 환경 변수에 curl에서 사용할 수 있도록 삽입할 수 있습니다.

Edge 관리 API 호출을 위해 OAuth2 액세스 토큰을 가져오려면 다음 안내를 따르세요.

  1. sso-cli 번들을 다운로드합니다.
    curl http://EDGE_SSO_IP_DNS:9099/resources/scripts/sso-cli/ssocli-bundle.zip -o "ssocli-bundle.zip"

    여기서 EDGE_SSO_IP_DNS은 Apigee SSO 모듈을 호스팅하는 머신의 IP 주소 또는 DNS 이름입니다. Apigee SSO에 TLS를 구성한 경우 https 및 올바른 TLS 포트 번호를 사용합니다.

  2. 다음 예에 표시된 대로 ssocli-bundle.zip 번들의 압축을 풉니다.
    unzip ssocli-bundle.zip
  3. 다음 예에 표시된 것처럼 /usr/local/binget_token를 설치합니다.
    ./install -b PATH

    -b 옵션은 다른 위치를 지정합니다.

  4. SSO_LOGIN_URL 환경 변수를 로그인 URL에
    export SSO_LOGIN_URL="http://EDGE_SSO_IP_DNS:9099"
    형식으로 설정합니다.

    여기서 EDGE_SSO_IP_DNS는 Apigee SSO 모듈을 호스팅하는 머신의 IP 주소입니다. Apigee SSO에 TLS를 구성한 경우 https 및 올바른 TLS 포트 번호를 사용합니다.

  5. (SAML만 해당) 브라우저에서 다음 URL로 이동하여 일회용 비밀번호를 가져옵니다.
    http://EDGE_SSO_IP_DNS:9099/passcode

    Apigee SSO에 TLS를 구성한 경우 https 및 올바른 TLS 포트 번호를 사용합니다.

    이 요청은 URL을 새로고침하여 새 비밀번호를 받거나 get_token에 비밀번호를 사용하여 액세스 토큰을 생성할 때까지 유효한 일회용 비밀번호를 반환합니다.

    SAML IDP로 인증할 때만 비밀번호를 사용할 수 있습니다. LDAP IDP로 인증하는 데 비밀번호를 사용할 수 없습니다.

  6. 다음 예와 같이 get_token를 호출하여 OAuth2 액세스 토큰을 가져옵니다.
    get_token -u EMAIL_ADDRESS

    여기서 EMAIL_ADDRESS는 Edge 사용자의 이메일 주소입니다.

    (SAML만 해당) 다음 예에 표시된 것처럼 이메일 주소와 함께 명령줄에 비밀번호를 입력합니다.

    get_token -u EMAIL_ADDRESS -p PASSCODE

    get_token 유틸리티가 OAuth2 액세스 토큰을 가져와서 화면에 출력하고 갱신 토큰을 ~/.sso-cli에 씁니다.

  7. 다음 예시와 같이 Edge 관리 API 호출에 액세스 토큰을 Bearer 헤더로 전달합니다.
    curl -H "Authorization: Bearer ACCESS_TOKEN"
      https://MS_IP:8080/v1/organizations/ORG_NAME
  8. 새 액세스 토큰을 처음 가져온 후 다음 예시와 같이 액세스 토큰을 가져와서 단일 명령어로 API 호출에 전달할 수 있습니다.
    header=`get_token` && curl -H "Authorization: Bearer $header"
      https://MS_IP:8080/v1/o/ORG_NAME

    이 명령어 형식을 사용하면 액세스 토큰이 만료된 경우 갱신 토큰이 만료될 때까지 자동으로 새로고침됩니다.

(SAML만 해당) 갱신 토큰이 만료되면 get_token에서 새 비밀번호를 입력하라는 메시지를 표시합니다. 새 OAuth 액세스 토큰을 생성하려면 먼저 3단계에 표시된 URL로 이동하여 새 비밀번호를 생성해야 합니다.

관리 API를 사용하여 토큰 가져오기 및 갱신

Apigee Edge 관리 API에서 OAuth2 보안 사용에서는 Edge 관리 API를 사용하여 토큰을 가져오고 갱신하는 방법을 보여줍니다. Edge API 호출을 사용하여 SAML 어설션에서 생성된 토큰을 가져올 수도 있습니다.

Apigee Edge 관리 API에서 OAuth2 보안 사용에 설명된 API 호출 간의 유일한 차이점은 호출 URL이 영역 이름을 참조해야 한다는 것입니다. 또한 SAML IDP로 초기 액세스 토큰을 생성하려면 위 절차의 3단계와 같이 비밀번호를 포함해야 합니다.

승인을 위해 Authorization 헤더에 예약된 OAuth2 클라이언트 사용자 인증 정보를 전달합니다. 호출하면 액세스 및 갱신 토큰이 화면에 출력됩니다.

액세스 토큰 가져오기

(LDAP) 다음 API 호출을 사용하여 초기 액세스 및 갱신 토큰을 생성합니다.

curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \
  -H "accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
  http://EDGE_SSO_IP_DNS:9099/oauth/token -s \
  -d 'grant_type=password&username=USER_EMAIL&password=USER_PASSWORD'

(SAML) 다음 API 호출을 사용하여 초기 액세스 및 갱신 토큰을 생성합니다.

curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \
  -H "accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
  https://EDGE_SSO_IP_DNS:9099/oauth/token -s \
  -d 'grant_type=password&response_type=token&passcode=PASSCODE'

SAML IDP를 사용한 인증에는 임시 비밀번호가 필요하지만 LDAP IDP를 사용하면 필요하지 않습니다.

액세스 토큰 새로고침

나중에 액세스 토큰을 새로고침하려면 갱신 토큰이 포함된 다음 호출을 사용합니다.

curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \
  -H "Accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
  https://EDGE_SSO_IP_DNS:9099/oauth/token \
  -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN'