Automation Anywhere 설명서 읽기 및 검토

Automation Anywhere

콘텐츠 닫기

콘텐츠

콘텐츠 열기

자격증명 저장소 관리 API

  • 업데이트: 5/10/2019
    • 11.3.x
    • 구축
    • Enterprise
    • API 문서

자격증명 저장소 관리 API

Enterprise 제어실내 자격증명 및 사물함 관리 역할 권한이 있는 사용자로서 자격증명 보관 API를 사용하여 자격증명, 속성, 사물함, 자격증명 보관 모드 관리를 Enterprise 제어실에서 합니다.

  1. 자격증명 관리 API를 자격증명 생성, 업데이트 및 삭제에 사용할 수 있습니다.
  2. 자격증명 속성 관리 API를 자격증명 속성 및 값 생성, 업데이트, 삭제에 사용할 수 있습니다.
  3. 사물함 관리 API를 소비자와 회원을 포함한 사물함의 추가, 편집 및 삭제에 사용할 수 있습니다.
  4. 자격증명 저장소 모드 관리 API 연결 모드를 구성해서 자격증명 보관 마스터 키를 사용하여 연결할 수 있습니다.
주: 제공된 예시는 참조 전용입니다.

API 종료 지점

다음 엔드포인트를 사용하여 자격증명 보관 API에 액세스합니다. <Enterprise 제어실 URL>/v2/credentialvault

예: https://crdevenv.com:81/v2/credentialvault

자격증명 관리 API

이 API를 사용하여 Enterprise 제어실에서 자격증명을 관리할 수 있습니다.

자격증명 보관 API에 액세스하기 전에 인증 API를 사용하여 특정 자격증명 보관 API에 이용할 토큰으로 전달해야 합니다.

  1. POST 메소드를 사용하여 엔드포인트 http(s)://<hostname:port>/v1/authentication을 사용하는 토큰을 생성합니다. 이를 위해 Enterprise 제어실 인스턴스를 서버 이름/호스트 이름/IP포트 번호로 입력합니다.

    예: https://crdevenv.com:81/v1/authentication

  2. 헤더에 다음의 요청 페이로드를 입력합니다.
    “X-Authorization” : “Authorization token” “Content-Type” : “application/json”
  3. 본문에 다음의 요청 페이로드를 입력합니다.
     { "username": "<Username>", "password": "<Password>" } 
    예: {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. 자격증명 생성

이 API를 사용하면 자격증명을 생성할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. POST 메소드를 사용하여 본문에 다음과 같은 요청 페이로드를 제공합니다.
    { "name": "<Credential Name>", "description": "<Credential Description>","attributes": [ { "name": "<Attribute Name>", "description": "<Attribute Description>", "userProvided": <true or false>, "masked": <true or false> } ] }
    예를 들면, 다음은 'SharePoint 로그인' 자격증명을 '사용자 이름' 속성으로 생성합니다.
    { "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "attributes": [ { "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true } ] }
  3. 보내기를 클릭합니다.
  4. 응답 상태가 201 자격증명 생성됨이면 작업이 성공한 것입니다.
  5. 본문 데이터의 응답을 볼 수 있습니다.
    { "id": "10", "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "ownerId": "1", "attributes": [ { "id": "58", "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true, "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" } ], "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" }

매개변수 설명

매개변수 설명
name 첫 번째 인스턴스의 자격증명 이름 및 두 번째 인스턴스의 속성 이름
설명 첫 번째 인스턴스의 자격증명 설명 및 두 번째 인스턴스의 속성 값 설명
userProvided 속성 유형이 사용자 제공 또는 표준입니다. 사용자 제공의 경우 으로 설정되며, 이는 기본 매개변수이기도 합니다. 속성 값 형식과 관련된 내용은 자격증명 생성에서 자세히 살펴보십시오.
masked 속성 값이 마스크됨입니다. 암호화된 경우 으로 설정됩니다. 구체적인 내용은 자격증명 생성에서 확인하십시오.

2. 자격증명 목록

이 API를 사용하면 사용자가 소유자이거나 사물함을 통해 액세스가 가능한 모든 자격증명을 볼 수 있습니다. 사용자가 사물함 관리자인 경우 시스템의 모든 자격증명을 나열합니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다. http(s)://<hostname:port>/v2/credentialvault/credentials?consumed="<true or false>"&name or names="<filter credentials name(s) separated by comma>"

    예를 들면, 다음은 사용하지 않은 모든 자격증명의 목록입니다.

    https://crdevenv.com:81/v2/credentialvault/credentials?consumed=false

  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 자격증명 찾음이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.
    { "list": [ { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ], "completed": false }, { "id": 11, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SharePoint-User1", "description": "name of the SharePoint user", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 59, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SP-User1", "description": "name of the user", "userProvided": true, "masked": false }, { "id": 60, "createdBy": 1, "createdOn": "2018-06-21T13:00:22+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 0, "name": "Victor.Hugo", "description": null, "userProvided": true, "masked": false } ], "completed": false ] }

매개변수 설명

매개변수 셜명
consumed 사용자 제공이며, 현재 사용자가 이용한 자격증명인 경우에는 자격증명을 필터링합니다.
name 단일 이름으로 자격증명을 필터링합니다.
names 쉼표로 구분한 이름 목록으로 자격증명을 필터링합니다.

3. ID로 자격증명 나열

이 API를 사용하면 ID를 매개변수로 제공하는 자격증명의 세부 정보를 볼 수 있습니다.

팁: 목록 자격증명 API를 사용하여 가져온 자격증명 목록에서 자격증명의 ID를 식별할 수 있습니다.
  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. GET 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다. http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    예를 들면, 다음은 ID 12가 있는 사용자 자격증명을 가져옵니다. https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. 보내기를 클릭합니다.

    응답 상태가 200인 경우 작업이 성공한 것입니다. 본문 데이터에서 응답을 볼 수 있습니다.

    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ] }

4. 자격증명 업데이트

이 API를 사용하면 기존 자격증명을 업데이트할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. PUT 메소드를 사용하여 자격증명 API에 액세스합니다.http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    예를 들면, 다음은 ID 12https://crdevenv.com:81/v2/credentialvault/credentials/12로 자격증명을 업데이트합니다.

  3. 본문에 다음과 같은 요청 페이로드를 입력합니다.
    { "id": "<Credential id>", "version": <Version id>, "name": "<Credential Name>", "description": "<Credential Description>", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": <Attribute id>, "version": 0, "name": "<Updated attribute name >", "description": "<Updated attribute description>", "userProvided": <False or true>, - Attribute type "masked": <false or true> masking is true or false } ] } 
    예를 들면, 자격증명 설명을 업데이트하려는 경우 다음 요청 매개변수를 제공할 수 있습니다.
    { "id": "12", "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": 61, "version": 0, "name": "<Updated attribute name >", "description": "SharePoint Username", "userProvided": <False or true>, - Attribute type "masked": true } ] }
    팁: 업데이트하려는 매개변수만 입력하고 다른 매개변수 값은 그대로 유지할 수 있습니다. 즉, 변경하지 않습니다.
  4. 보내기를 클릭합니다.
  5. 응답 상태가 200 자격증명 업데이트됨이면 작업이 성공한 것입니다.
  6. 본문 데이터에서 응답을 볼 수 있습니다.
    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true } ] }

매개변수 설명

매개변수 셜명
id 첫 번째 인스턴스의 자격증명 ID 및 두 번째 인스턴스의 속성 ID ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
버전 첫 번째 인스턴스의 자격증명 업데이트 버전 ID 및 두 번째 인스턴스의 속성 이전 버전과 현재 버전이 일치하지 않으면 충돌 오류가 표시됩니다.
name 첫 번째 인스턴스의 업데이트된 자격증명 및 두 번째 인스턴스의 속성 값
설명 첫 번째 인스턴스의 업데이트된 자격증명 설명 및 두 번째 인스턴스의 속성 값 설명
lockerId 가능한 경우 사물함 ID입니다. 사물함 ID가 제공되지 않으면, 기본값은 값입니다. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
ownerId 자격증명 소유자의 사용자 ID입니다. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
userProvided 속성 유형이 사용자 제공 또는 표준입니다. 사용자 제공의 경우 으로 설정되며, 이는 기본 매개변수이기도 합니다. 속성 값 형식과 관련된 세부 내용은 자격증명 생성에서 참고하십시오.
마스크 속성 값이 마스크됨입니다. 암호화된 경우 으로 설정됩니다. 자세한 내용은 자격증명 생성에서 참고하십시오.

5. 자격증명 소유권 업데이트

이 API를 사용하면 자격증명의 소유권을 업데이트할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. PUT 메소드를 사용하여 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/owner/<credentialOwnerId>

    예를 들면, 다음은 ID 12가 있는 자격증명 소유권을 소유자 1에서 2로 변경합니다.

    https://crdevenv.com:81/v2/credentialvault/credentials/12/owner/2
  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 자격증명 소유권의 성공적인 업데이트라면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1,

    "attributes":

    [

    { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true }

    ]

    }

매개변수 설명

매개변수 셜명
id 자격증명의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
credentialOwnerId 새 자격증명 소유자의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.

6. 자격증명 삭제

이 API를 사용하면 ID를 매개변수로 제공하는 자격증명을 삭제할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. DELETE 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    예를 들면, 다음은 ID 11이 있는 자격증명을 삭제했습니다.

    https://crdevenv.com:81/v2/credentialvault/credentials/11

  3. 보내기를 클릭합니다.

    응답 상태가 204 성공적으로 삭제라면 작업이 성공한 것입니다.

자격증명 속성 관리 API

Enterprise 제어실 사용자로서 모든 자격증명 속성 값 보기 및 편집 권한이 있는 경우, 자격증명 속성 API를 사용하여 Enterprise 제어실에서 자격증명 속성 및 해당 값을 관리합니다. 따라서 이 API를 사용하면 사용자가 만든 자격증명의 속성 값을 만들고, 편집하고, 삭제할 수 있습니다.

자격증명 보관 API에 액세스하기 전에 인증 API를 사용하여 특정 자격증명 보관 API에 이용할 토큰으로 전달해야 합니다.

  1. POST 메소드를 사용하여 엔드포인트 http(s)://<hostname:port>/v1/authentication을 사용하는 토큰을 생성합니다. 이를 위해 Enterprise 제어실 인스턴스를 서버 이름/호스트 이름/IP포트 번호로 입력합니다.

    예: https://crdevenv.com:81/v1/authentication

  2. POST 메소드를 사용하여 자격증명 API에 액세스합니다.

    예: GET https://crdevenv.com:81/v2/credentialvault/credentials

  3. 헤더에 다음 요청 페이로드를 입력합니다.

    “X-Authorization” : “Authorization token”

    “Content-Type” : “application/json”

1. 속성 값 생성

이 API를 사용하면 ID를 매개변수로 제공하는 자격증명의 속성 값을 만들 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. POST 메소드를 사용하여 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue

    예를 들면, 다음은 속성 사용자 이름을 자격증명 ID 12에 대해 생성합니다.

    https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. 본문에 요청 페이로드를 입력합니다.
    [ { "credentialAttributeId": "<Attribute Id>", "value": "<attribute value>" } ] 

    예를 들어 이전 예에서 만든 'SharePoint 로그인' ID '12', 속성 '사용자 이름' ID '30'에 대해 다음과 같이 값을 추가할 수 있습니다.

    [

    {

    "credentialAttributeId": "30",

    "value": "Jane.Smith"

    }

    ]

  4. 보내기를 클릭합니다.
  5. 응답 상태가 201 자격증명 속성 값 생성됨이면 작업이 성공한 것입니다.
  6. 본문 데이터에서 응답을 볼 수 있습니다.

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:18:13+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:18:13+05:30","tenantId":1,"version":0,"userId":null,"value":"Jane.Smith","credentialAttributeId":62

    }

    ]

매개변수 설명

매개변수 셜명
credentialAttributeId 속성의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
입력하려는 속성 값

2. 자격증명 속성 값 목록

이 API를 사용하여 특정 자격증명에 대한 모든 표준 및 사용자 지정 값을 나열할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalues

    예를 들어 자격증명 'SharePoint 로그인' ID '12', 속성 '사용자 이름' ID '30'에 대해 다음과 같이 값을 추가할 수 있습니다.

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues

  3. 보내기를 클릭합니다.

    응답 상태가 200 자격증명 속성 값 찾음이면 작업이 성공한 것입니다.

  4. 본문 데이터에서 응답을 볼 수 있습니다.

    { "list":[

    {

    "id": 30, "createdBy": 1, "createdOn": "2018-06-27T14:16:20+05:30", "updatedBy": 1, "updatedOn": "2018-06-27T14:16:20+05:30", "tenantId": 1, "version": 0, "userId": null, "value": "Jane.Smith", "credentialAttributeId": 62

    }

    ]}

매개변수 설명

매개변수 셜명
id 자격증명의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
credentialAttributeId 속성의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
userId Enterprise 제어실 사용자의 ID

3. 자격증명 속성 값 업데이트

이 API를 사용하면 특정 자격증명의 속성 값을 업데이트할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. PUT 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault//credentials/<id>/attributevalues/<attributeValueId>

    예를 들어 자격증명 'SharePoint 로그인' ID '12', 속성 '사용자 이름' ID '30'에 대해 다음과 같이 값을 업데이트할 수 있습니다.

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues/30

  3. 본문에 요청 페이로드를 입력합니다.

    [

    {

    "id": "<Attribute value id>", "version": 0, "value": "<Attribute value>", "credentialAttributeId": "<Attribute ID>"

    }

    ]

  4. 보내기를 클릭합니다.

    응답 상태가 200 자격증명 속성 값 업데이트됨이면 작업이 성공한 것입니다.

  5. 본문 데이터에서 응답을 볼 수 있습니다.

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:47:55+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:47:55+05:30","tenantId":1,"version":0,"userId":null,"value":"","credentialAttributeId":62

    }

    ]

매개변수 설명

매개변수 셜명
id 속성 값의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.
버전 업데이트한 속성 값의 버전 번호
credentialAttributeId 속성의 ID. ID로 자격증명 가져오기 API를 사용하여 식별할 수 있습니다.

자격증명 속성 값 삭제

이 API를 사용하면 특정 자격증명의 속성 값을 삭제할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. 자격증명 API를 이용하여 자격증명 속성 값을 삭제하려면 다음 매개변수와 함께 DELETE 메소드를 사용합니다.

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/values/<attributeValueId>

    예: https://crdevenv.com:81/v2/credentialvault/credentials/12/values/30
  3. 보내기를 클릭합니다.
  4. 응답 상태가 204 성공적으로 삭제라면 작업이 성공한 것입니다.

사물함 관리 API

Enterprise 제어실 관리자로서 모든 사물함 관리 권한이 있거나 Enterprise 제어실 사용자로서 나의 사물함 관리 권한이 있으면, 사물함 관리 API를 사용하여 Enterprise 제어실에서 사물함, 소비자 및 회원을 생성, 업데이트 및 삭제할 수 있습니다.

API 액세스 전에 인증 API를 사용하여 특정 자격증명 보관 API에 사용할 토큰으로 전달해야 합니다.

  1. POST 메소드를 사용하여 엔드포인트 http(s)://<hostname:port>/v1/authentication을 사용하는 토큰을 생성합니다. 이를 위해 Enterprise 제어실 인스턴스를 서버 이름/호스트 이름/IP포트 번호로 입력합니다.

    예: https://crdevenv.com:81/v1/authentication

  2. POST 메소드를 사용하여 자격증명 API에 액세스합니다.

    예: GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. 헤더에 다음 요청 페이로드를 입력합니다.

    “X-Authorization”: "인증 토큰"

    "콘텐츠 유형": “application/json”

1. 사물함 목록

이 API는 로그인한 사용자가 회원(소유자, 관리자 또는 참여자)이거나 사용 권한을 보유한 사물함 목록을 가져옵니다. 사용자가 사물함 관리자인 경우 시스템의 모든 사물함 목록을 가져옵니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음과 같은 매개변수로 사물함 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers?consumed="<true or false>"

    예를 들면, 다음은 사용하지 않은 모든 사물함의 목록입니다.

    https://crdevenv.com:81/v2/credentialvault/lockers?consumed=false

  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 사물함 찾음이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    { "list":

    [

    {

    "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:41:04.682Z", "tenantId": 1, "version": 1

    },

    {

    "id": 3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:47:33.532Z", "tenantId": 1, "version": 0

    }

    ]}

매개변수 설명

매개변수 셜명
id 사물함 ID
name 사물함의 이름
설명 사물함에 대한 설명
consumed 로그인한 사용자가 이용했는지 여부입니다. 참 또는 거짓일 수 있습니다.

2. 보관함 생성

이 API를 사용하면 사물함을 생성할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. POST 메소드를 사용하여 사물함 API에 액세스합니다. http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue
    • 예를 들면, 다음은 속성 사용자 이름을 자격증명 ID 12에 대해 생성합니다.https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. 본문에 요청 페이로드를 입력합니다.
    { "name":"<Locker name>" , "description":"<Locker description>" }
    • 예를 들면, 다음은 "SalesForce" 사물함
      { "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application" }
      을 생성합니다.
  4. 보내기를 클릭합니다.
  5. 응답 상태가 201 사물함 생성됨이면 작업이 성공한 것입니다.
  6. 본문 데이터에서 응답을 볼 수 있습니다.
    { "id": 4, "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0 }

매개변수 설명

매개변수 셜명
name 사물함 관리자가 제공한 사물함의 이름
설명 사물함의 설명

3. 추가 필드가 포함된 모든 사물함 목록

이 API는 로그인한 사용자가 회원(소유자, 관리자 또는 참여자)이거나 사용 권한을 보유한 사물함 목록을 가져옵니다. 사용자가 사물함 관리자인 경우 시스템의 모든 사물함 목록을 가져옵니다. 응답에는 사물함 회원과 각 사물함 내부의 자격증명 개수가 포함됩니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음과 같은 매개변수로 사물함 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/advanced

    • 예를 들면, 다음은 추가 필드가 있는 모든 사물함 이름을 나열합니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/advanced

  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 사물함 찾음이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    { "list":[

    { "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.163Z", "tenantId": 1, "version": 2, "members": [ { "id": 1, "permissions": [ "participate", "manage" ] }, { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 1 },

    { "id": 3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:47:33.532Z", "tenantId": 1, "version": 0, "members": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 },

    { "id": 4, "name": "SalesForce Locker", "description": "-", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0, "members": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 }

    ]}

4. ID별로 사물함 나열

이 API를 사용하면 ID를 기반으로 사물함 세부 정보를 가져올 수 있습니다.
팁: 목록 사물함 API를 사용하여 가져온 사물함 목록의 사물함 ID를 식별할 수 있습니다.
  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. GET 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • 예를 들면, 다음은 ID 2가 있는 사물함을 가져옵니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 사물함이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.163Z", "tenantId": 1, "version": 2

    }

5. 사물함 업데이트

이 API를 사용하면 특정 사물함의 값을 업데이트할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. PUT 메소드를 사용하여 다음 매개변수로 자격증명 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault//lockers/<id>

    • 예를 들면, 사물함 'SharePoint 사물함' ID '2'에 대해 다음과 같이 값을 업데이트할 수 있습니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. 본문에 요청 페이로드를 입력합니다.

    {

    "id": " <locker id> ","name ": "<updated lockername>", "description": "<updated description>", "version": 0

    }

  4. 보내기를 클릭합니다.
  5. 응답 상태가 200 사물함 업데이트됨이면 작업이 성공한 것입니다.
  6. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "id": 2, "createdBy": 8, "createdOn": "2018-06-16T10:59:33Z", "updatedBy": 8, "updatedOn": "2018-06-16T10:59:37Z", "version": 1, "name": "SharePoint-Locker", "description": "SharePoint 자격증명을 관리하는 사물함"

    }

매개변수 설명

매개변수 셜명
id 사물함의 ID ID로 사물함 가져오기 API를 사용하여 식별할 수 있습니다.
버전 업데이트한 사물함 값의 버전 번호
name 업데이트한 사물함의 이름
설명 업데이트한 사물함의 설명

6. 사물함 삭제

이 API를 사용하면 ID를 매개변수로 제공하는 사물함을 삭제할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. 사물함 API를 사용하여 사물함의 자격증명을 삭제하려면 다음 매개변수가 있는 DELETE 메소드를 사용합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • 예를 들면, 다음은 ID 4가 있는 자격증명을 삭제합니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/4

  3. 보내기를 클릭합니다.
  4. 응답 상태가 204 성공적으로 삭제라면 작업이 성공한 것입니다.

7. 모든 사물함 소비자 목록

이 API를 이용하면 사물함에 자격증명을 사용할 수 있는 역할 목록을 가져올 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음과 같은 매개변수로 사물함 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • 예를 들면, 다음은 ID 2가 있는 사물함의 자격증명을 사용할 수 있는 역할을 가져옵니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers

  3. 보내기를 클릭합니다.
  4. 응답 상태가 204 성공이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "list":

    [

    { "id": "14" }

    ]

    }

8. 사물함 소비자 추가

이 API를 사용하면 특정 사물함에 소비자를 추가할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. PUT 메소드를 사용하여 다음 매개변수로 사물함 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • 예를 들어 다음과 같이 하면 ID 2가 있는 사물함에 소비자 ID 14가 있는 역할을 추가할 수 있습니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. 본문에 요청 페이로드를 입력합니다.

    {

    "id": "<consumer id>"

    }
    • 예:

      {

      "id": 14

      }

  4. 보내기를 클릭합니다.
  5. 응답 상태가 204 사물함 소비자의 성공적인 생성이면 작업이 성공한 것입니다.

매개변수 설명

매개변수 셜명
id 사물함 소비자의 ID ID로 사물함 가져오기 API를 사용하여 식별할 수 있습니다.

9. 사물함 소비자 삭제

이 API를 사용하면 특정 사물함에서 소비자를 삭제할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. 사물함 API를 사용하여 사물함 소비자를 삭제하려면 다음 매개변수가 있는 DELETE 메소드를 사용합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/consumers/<roleId>

    • 예를 들면, 다음은 ID 2가 있는 자격증명을 삭제합니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers/14

  3. 보내기를 클릭합니다.
  4. 응답 상태가 204 성공적으로 삭제라면 작업이 성공한 것입니다.

10. 모든 사물함 회원 목록

이 API를 사용하면 특정 사물함에서 자격증명을 추가/삭제하거나 사물함 설정을 편집할 수 있는 모든 사용자의 목록을 가져올 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음과 같은 매개변수로 사물함 API에 액세스합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members

    • 예를 들면, 다음은 ID 2가 있는 사물함에서 사용자를 추가/삭제할 수 있는 사용자를 가져옵니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members

  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 사물함 회원이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "list":

    [

    {

    "id": 1, "permissions": [ "participate", "manage" ]

    },

    {

    "id": 2, "permissions": [ "participate", "own", "manage" ]

    }

    ]

    }

11. 사물함 회원 추가 또는 업데이트

이 API를 사용하면 사물함에서 자격증명을 추가/삭제하거나 사물함 설정을 편집할 수 있는 사용자를 추가할 수 있습니다.

  1. 헤더에 다음 "X-Authorization" 및 "Content Type" 매개변수를 입력합니다.
  2. PUT 메소드를 사용하여 다음 매개변수로 사물함 API를 이용하는 사용자를 추가/업데이트합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • 예를 들어 다음과 같이 하면 ID 2가 있는 사물함에 소비자 ID 3이 있는 사용자를 추가할 수 있습니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. 본문에 요청 페이로드를 입력합니다.

    {

    "permissions":

    ["permission type"]

    }

    • 예를 들어,

      {

      "permissions":

      ["participate", "manage"]

      }

  4. 보내기를 클릭합니다.
  5. 응답 상태가 204 사물함 회원의 성공적인 생성/업데이트라면 작업이 성공한 것입니다.

매개변수 설명

매개변수 셜명
권한 사용자에게 부여한 권한. 이는 소유자, 참여자 및/또는 관리자일 수 있습니다.

12. 사물함 회원 삭제

이 API를 이용하면 특정 사물함에서 사물함 사용자 또는 회원을 삭제할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. 사물함 API를 사용하여 사물함 소비자를 삭제하려면 다음 매개변수가 있는 DELETE 메소드를 사용합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • 예를 들면, 다음은 ID 3이 있는 사물함 사용자를 삭제합니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. 보내기를 클릭합니다.
  4. 응답 상태가 204 사물함 회원의 삭제라면 작업이 성공한 것입니다.

13. 사물함에 자격증명 추가

이 API를 사용하면 소유자, 관리자 또는 참여자 권한이 있는 사물함에 본인의 자격증명을 추가할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. 자격증명 API를 사용하여 사물함에 자격증명을 추가하려면 다음 매개변수와 함께 PUT 메소드를 사용합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • 예를 들면, 다음은 ID 2가 있는 사물함에 자격증명을 추가합니다. https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/58
  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 자격증명이 사물함에 추가됨이면 작업이 성공한 것입니다.

14. 모든 사물함 자격증명 목록

이 API를 사용하면 소유자, 관리자 또는 참여자 권한을 보유한 사물함에 있는 자격증명 목록을 가져올 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 이용하여 다음 매개변수와 함께 자격증명 API를 사용하는 자격증명 목록을 가져옵니다.
    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/
    • 예를 들면, 다음은 ID 2가 있는 사물함에 추가된 모든 자격증명을 나열합니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/

  3. 보내기를 클릭합니다.
  4. 응답 상태가 200 사물함 자격증명이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    { "list": [

    {

    "id": 10, "name": "SharePoint Credentials", "description": "", "completed": false, "lockerId": 2, "ownerId": 2, "attributes":

    [

    {

    "id": 58, "name": "username", "description": "", "userProvided": true, "masked": false, "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:09:32.854Z", "tenantId": 1, "version": 0

    },

    {

    "id": 59, "name": "password", "description": "", "userProvided": true, "masked": true, "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:09:32.854Z", "tenantId": 1, "version": 0

    }

    ],

    "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.316Z", "tenantId": 1, "version": 1

    }

    ]}

15. 사물함에서 자격증명 삭제

이 API를 이용하면 특정 사물함에서 사물함 사용자 또는 회원을 삭제할 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. 사물함 API를 사용하여 사물함 소비자를 삭제하려면 다음 매개변수가 있는 DELETE 메소드를 사용합니다.

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • 예를 들면, 다음은 ID 59가 있는 자격증명을 ID 2가 있는 사물함에서 삭제합니다.

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/59

  3. 보내기를 클릭합니다.
  4. 응답 상태가 204 자격증명이 사물함에서 삭제됨이면 작업이 성공한 것입니다.

자격증명 저장소 모드 관리 API

Enterprise 제어실 관리자로서 설정 보기 및 관리 권한이 있으면 자격증명 보관 모드 관리 API를 사용하여 Enterprise 제어실자격증명 보관 모드를 관리할 수 있습니다.

API 액세스 전에 인증 API를 사용하여 특정 자격증명 보관 API에 사용할 토큰으로 전달해야 합니다.

  1. POST 메소드를 사용하여 엔드포인트 http(s)://<hostname:port>/v1/authentication을 사용하는 토큰을 생성합니다. 이를 위해 Enterprise 제어실 인스턴스를 서버 이름/호스트 이름/IP포트 번호로 입력합니다.

    예: https://crdevenv.com:81/v1/authentication

  2. POST 메소드를 사용하여 자격증명 API에 액세스합니다.

    예: GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. 헤더에 다음 요청 페이로드를 입력합니다.

    “X-Authorization”: "인증 토큰"

    "콘텐츠 유형": “application/json”

현재 자격증명 저장소 모드 보기

이 API를 사용하면 자격증명 보관에 연결하는 데 이용한 현재 모드를 볼 수 있습니다. '익스프레스' 또는 '수동'일 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음 매개변수로 자격증명 보관 API에 액세스합니다.
    http(s)://<hostname:port>/v2/credentialvault/mode
    • 예를 들면, 다음은 자격증명 보관에 연결하는 데 사용하는 현재 모드를 표시합니다.

      https://crdevenv.com:81/v2/credentialvault/mode

  3. 보내기/실행 클릭
  4. 응답 상태가 200 CV 모드를 성공적으로 수신했음이면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "name": "Express"

    }

자격증명 보관 모드 업데이트

이 API를 사용하면 자격증명 보관에 연결하는 데 사용한 모드를 변경할 수 있습니다. '익스프레스' 또는 '수동'일 수 있습니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. PUT 메소드를 사용하여 다음 매개변수로 자격증명 보관 API에 액세스합니다.
    http(s)://<hostname:port>/v2/credentialvault/mode
    • 예를 들면, 다음은 자격증명 보관에 연결하는 데 사용하는 현재 모드를 표시합니다.

      https://crdevenv.com:81/v2/credentialvault/mode

  3. 해당 본문에 요청 페이로드를 입력합니다.

    {

    "name": "<mode>",

    "privatekey": "<CV Key>"

    }
    • 예를 들어,

      {

      "name": "Manual",

      "privatekey": "ABC123"

      }

  4. 보내기/실행 클릭
  5. 응답 상태가 204 CV 모드를 성공적으로 설정했음이면 작업이 성공한 것입니다.

매개변수 설명

매개변수 셜명
name 연결 유형 - 수동 또는 익스프레스. 이것은 Enterprise 제어실의 초기 구성 중에 지정됩니다. Enterprise 제어실 설정을 참고하여 Enterprise 제어실 UI에서 이를 업데이트합니다.
key 자격증명 보관에 연결하는 데 사용하는 마스터 키입니다.

마스터 키가 적용되었는지 확인합니다.

이 API를 사용하면 자격증명 보관 연결에 Enterprise 제어실 마스터 키가 적용되었는지 확인할 수 있습니다. 이를 사용하여 자격증명 보관 상태를 확인합니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. GET 메소드를 사용하여 다음 매개변수로 자격증명 보관 API에 액세스합니다.
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • 예를 들어,

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. 보내기/실행 클릭
  4. 응답 상태가 200 비밀 키 상태라면 작업이 성공한 것입니다.
  5. 본문 데이터에서 응답을 볼 수 있습니다.

    {

    "applied": true

    }
    주: 비밀 키가 적용되지 않은 경우 거짓으로 값이 표시됩니다.

수동 모드에서 Enterprise 제어실을 재시작한 후 자격증명 저장소를 잠금해제하기 위해 마스터 키 적용

이 API를 사용하면 수동 연결 모드를 사용해 Enterprise 제어실을 재시작한 후 자격증명 보관를 잠금해제할 수 있습니다. 이를 사용하여 자격증명 보관의 연결 여부를 확인합니다.

  1. 헤더에 'X-Authorization' 매개변수를 제공합니다.
  2. PUT 메소드를 사용하여 다음 매개변수로 자격증명 보관 API에 액세스합니다.
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • 예를 들어,

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. 해당 본문에 요청 페이로드를 입력합니다.

    {

    "privateKey": "<CV Key>"

    }

  4. 보내기/실행 클릭
  5. 응답 상태가 200 비밀 키를 성공적으로 작용했음이면 작업이 성공한 것입니다.

매개변수 설명

매개변수 셜명
privateKey 자격증명 보관에 연결하는 데 사용하는 마스터 키입니다. 이것은 Enterprise 제어실의 초기 구성 중에 지정됩니다. 이 키를 제공함으로써 Enterprise 제어실 설정에서 모드를 변경할 수 있습니다.

API 응답 코드

HTTP (s) 상태 코드 응답 - 설명 수정 조치
200/204 작업이 성공적으로 완료되었습니다. NA
304 적용된 변경사항 없음 필요에 따라 업데이트
400 잘못된 요청 매개 변수 유효한 매개 변수로 다시 시도하십시오.
401 인증 필요 인증 매개변수를 입력하십시오. 예: X-Authorization 키
403 무단 액세스 Enterprise 제어실 액세스 권한이 있는지 확인하십시오.
404 찾을 수 없음 요청 페이로드가 Enterprise 제어실에서 사용 가능한지 확인하십시오.
409 충돌 제공된 매개변수가 올바른지 확인하십시오.
500 내부 서버 오류 서버가 작동되어 실행 중인지 확인하십시오.
501 Permission error 필요한 권한이 있는지 확인하십시오.

감사 로그

모든 API 활동은 Enterprise 제어실 감사 로그 페이지에 기록됩니다. Enterprise 제어실 관리자 또는 모든 사용자의 감사 로그 작업 보기 권한이 있는 사용자는 다음과 같이 감사 항목을 볼 수 있습니다.

API 활동을 캡처한 감사 로그 페이지

다음 그림은 사물함 API로 사물함을 만들기 위한 감사 로그 세부 정보 페이지의 예입니다.

사물함 활동 추가에 대한 정보가 있는 감사 로그 세부 정보 페이지

피드백을 보내주십시오