서비스 신임 정보 관리 REST API

등록 서비스 REST API를 사용하여 사용자, 서비스 신임 정보 및 해당 Operational Decision Manager on Cloud 역할을 관리할 수 있습니다.

이 태스크에 대한 정보

시작하기 전에 다음 요구사항을 준수해야 합니다.
  • 클라우드 관리자 권한을 가지고 있어야 합니다.
  • 모든 API 호출은 호출의 IBM-CSRF-TOKEN 헤더에 유효한 CSRF(Cross-Site Request Forgery) 토큰이 있어야 합니다. CSRF 토큰을 얻으려면 POST/instance/services/csrf_token을 사용하십시오. 자세한 정보는 사이트 간 요청 위조 방지를 참조하십시오.

서비스 신임 정보 세트 작성

서비스 신임 정보 세트를 작성합니다.

이 태스크에 대한 정보

이 프로시저는 REST API를 사용하여 서비스 신임 정보를 작성하는 방법을 보여줍니다. 자세한 정보는 클라이언트 애플리케이션 인증을 참조하십시오.

프로시저

  1. API 오퍼레이션을 위한 애플리케이션에서, 호출의 본문에 JSON 오브젝트의 접두부를 지정하여 인증 정보 ID를 생성하십시오.

    예를 들어, 대출 애플리케이션에 대한 인증 정보를 작성하려는 경우에는 다음 호출을 사용하십시오.

    POST /instance/services/credentials/service_credentials
    ...
    {
      "prefix": "loanapp"
      "description": "Service credentials for loan application."  
    }
  2. 인증 정보의 용도를 쉽게 식별할 수 있도록 의미 있는 설명을 입력하십시오.
    리턴되는 오브젝트는 기능과 연관된 ID, 그리고 매우 안전한 비밀번호를 포함합니다.
    주: 권한 관리자 Operational Decision Manager on Cloud 역할을 API로 작성된 서비스 신임 정보에 지정하려면 포털 또는 그룹 관리 REST API를 사용하십시오. 그룹 관리를 참조하십시오.

서비스 신임 정보 목록 검색

등록의 서비스 신임 정보 목록을 표시합니다.

이 태스크에 대한 정보

이 프로시저는 등록의 서비스 신임 정보 목록을 검색하는 방법을 보여줍니다.

프로시저

  1. API 오퍼레이션을 위한 애플리케이션에서 다음 호출을 입력하십시오.
    GET /instance/services/credentials/service_credentials
    서비스 신임 정보 목록이 리턴됩니다. 각 항목은 서비스 인증 정보 ID, 인증 정보의 작성자, 작성 시간, 그리고 설명(있는 경우)을 포함합니다.
  2. 오프셋과 크기 매개변수를 사용하여 호출에 채우기를 추가하십시오.
    GET /instance/services/credentials/service_credentials?offset=11&size=10

서비스 신임 정보 세트 삭제

서비스 신임 정보 세트를 삭제합니다.

이 태스크에 대한 정보

이 프로시저는 서비스 신임 정보 세트를 삭제하는 방법을 보여줍니다.

프로시저

API 오퍼레이션을 위한 애플리케이션에서 다음 호출을 입력하십시오.
DELETE /instance/services/credentials/service_credentials/{service_credential_id}
서비스 신임 정보 ID 및 비밀번호가 삭제됩니다.

등록에서 서비스 신임 정보 세트 공유

등록에서 서비스 신임 정보 세트를 공유합니다.

이 태스크에 대한 정보

이 프로시저는 둘 이상의 Operational Decision Manager on Cloud 등록이 있는 경우 등록에서 서비스 신임 정보 세트를 공유하는 방법을 보여줍니다.

프로시저

  1. 구독 중 하나에서 포털 또는 API를 사용하여 서비스 인증 정보 세트를 작성하십시오.
  2. 동일한 구독에서, API를 사용하여 서비스 인증 정보를 다른 구독으로 가져올 권한을 부여하는 서비스 인증 정보 가져오기 토큰을 작성하십시오.
    POST /instance/services/credentials/import_tokens
    ...
    {
      "service_credential_id": "prefix.fid@t123"
    }
    리턴되는 오브젝트에는 가져오기 토큰이 포함되어 있습니다. 이는 30분 동안 유효합니다. 이 가져오기 토큰은 특정 서비스 인증 정보에 대해 고유하지만, 사용자는 이 토큰이 만료되기 전에 이를 재사용하여 여러 구독으로 해당 서비스 인증 정보를 가져올 수 있습니다.
  3. 다른 구독에서는 API를 사용해 해당 서비스 인증 정보를 각 구독으로 가져와, 각 구독의 클라이언트 애플리케이션에서 이 인증 정보를 사용할 수 있도록 하십시오.
    POST /instance/services/credentials/service_credentials/prefix.fid@t123/import
    ...
    {
      "import_token_value": "string",
      "description": "string"
    }

    설명은 각 등록에서 다를 수 있습니다.

  4. 필요한 경우, 다른 등록에서는 그룹 관리 API를 사용하여 포털 또는 Operational Decision Manager on Cloud 역할을 사용하여 가져온 서비스 신임 정보를 클라우드 관리자 역할에 지정하십시오.
    서비스 인증 정보 세트에서 더 이상 구독에 대한 액세스를 필요로 하지 않는 경우에는 클라우드 포털 또는 API를 사용하여 해당 구독에서 이를 삭제할 수 있습니다.

서비스 인증 정보의 비밀번호 재생성

서비스 인증 정보의 비밀번호를 재생성합니다.

이 태스크에 대한 정보

이 절차는 서비스 인증 정보의 비밀번호를 재생성하는 방법을 보여줍니다.

프로시저

API 오퍼레이션을 위한 애플리케이션에서 다음 호출을 입력하십시오.
PUT /instance/services/credentials/service_credentials/{service_credential_id}/password
리턴되는 오브젝트는 새 비밀번호인 secret 특성을 포함합니다.