API를 사용하여 속성 값으로 자격증명 구성
표준 속성으로 자격증명을 생성하고 사용자 입력 값을 사용하여 두 개의 추가 속성을 추가합니다.
전제 조건
주: Community Edition에서 Control Room APIs을 볼 수 있지만, API 기능은 제한됩니다. API의 전체 기능에 액세스하려면 라이선스가 인가된 Automation 360 에디션이 필요합니다.
- 인증 API를 이용하여 JSON 웹 토큰을 생성합니다. 인증 API를 참고하십시오.
- 모든 역할은 자격증명 및 속성을 구성하는 데 필요한
Manage my credentials and lockers권한을 가지고 있습니다. 이 엔드포인트를 사용하는 데 추가 권한은 필요하지 않습니다.
프로시저
- 요청 헤더에 인증 토큰을 추가합니다.
자격증명을 생성합니다.
-
POST 메소드 및 엔드포인트 URL 이용:
<your_control_room_url>/v2/credentialvault/credentials.요청 본문: 이 예시 요청에는 다음과 같은 필수 매개변수가 포함되어 있습니다.userProvided: 속성에 사용자 입력이 필요한지(true) 아니면 모든 사용자에 대한 표준인지(false)를 구성하는 부울 값입니다.masked: 속성값이 별표로 마스크되는지(true) 아니면 사용자가 볼 수 있는지(false)를 구성하는 부울 값입니다.
{ "name": "Email", "attributes": [ { "name": "hostname", "userProvided": false, "masked": false } ] } -
요청 전송.
응답 본문: 요청이 성공적인 경우 이 엔드포인트는 다음 데이터를 반환합니다.
id: 자격증명에 대한 고유한 숫자 식별자입니다.attributes:id: 속성에 대한 고유한 숫자 식별자입니다.
REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다. 응답 코드는 API 응답 코드를 참고하십시오.{ "id": "1630", "name": "Email", "description": "", "ownerId": "1508", "attributes": [ { "id": "3335", "name": "hostname", "description": "", "userProvided": false, "masked": false, "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366448Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:04:41.366450Z", "version": "0", "passwordFlag": false } ], "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366460Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:04:41.366464Z", "version": "0" }
이 자격증명에 대한 hostname 속성에 표준 값을 할당합니다.
-
POST 메소드 및 엔드포인트 URL 이용:
<your_control_room_url>/v2/credentialvault/credentials/{credentialId}/attributevalues.{ "list": [ { "credentialAttributeId": "3335", "value": "mail.example.com" } ] } -
요청 전송.
응답 본문:
{ "list": [ { "id": "1630", "credentialAttributeId": "3335", "value": "mail.example.com", "userId": "1508", "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366460Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:04:41.366464Z", "version": "0" } ] } -
username및password속성을Email자격증명에 추가합니다. PUT 메소드 및 엔드포인트 URL 이용:<your_control_room_url>/v2/credentialvault/credentials/{credentialId}주: 요청에 새 속성과 함께 기존 속성을 포함해야 합니다. 그렇지 않으면 현재 속성을 덮어씁니다.요청 본문: 요청 URL에 자격증명 ID를 지정했으므로 요청 본문에 자격증명 ID 또는 이름을 포함할 필요가 없습니다. 이 예제 요청 본문에서username및password속성은 각 사용자의 다른 입력을 허용하는 값으로 구성되어 있습니다. 또한 비밀번호 속성은 별표로 입력된 값을 마스킹하도록 구성되어 있습니다.{ "attributes": [ { "name": "username", "userProvided": true, "masked": false }, { "name": "password", "userProvided": true, "masked": true }, { "name": "hostname", "userProvided": false, "masked": false } ] } -
요청 전송.
응답 본문: 응답 본문은 세 가지 속성의 세부 정보와 함께 자격증명을 반환합니다.
{ "id": "1630", "name": "Email", "description": "", "ownerId": "1508", "attributes": [ { "id": "3335", "name": "hostname", "description": "", "userProvided": false, "masked": false, "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366448Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:04:41.366450Z", "version": "0", "passwordFlag": false }, { "id": "3336", "name": "username", "description": "", "userProvided": true, "masked": false, "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366450Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:04:41.366450Z", "version": "0", "passwordFlag": false }, { "id": "3337", "name": "password", "description": "", "userProvided": true, "masked": true, "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366450Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:04:41.366450Z", "version": "0", "passwordFlag": false } ], "createdBy": "1508", "createdOn": "2020-12-28T22:04:41.366460Z", "updatedBy": "1508", "updatedOn": "2020-12-28T22:06:35.366464Z", "version": "2" }