자격 증명 구성 만들기
Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
API 끝점: platform.adobe.io/data/core/activation/authoring/credentials
이 페이지에서는 /authoring/credentials API 끝점을 사용하여 자격 증명 구성을 만드는 데 사용할 수 있는 API 요청 및 페이로드를 구현합니다.
/credentials API 끝점을 사용해야 하는 경우 when-to-use
대부분의 경우 API 끝점 /credentials을(를) 사용하지 할 필요가 없습니다. 대신 /destinations 끝점의 customerAuthenticationConfigurations 매개 변수를 통해 대상에 대한 인증 정보를 구성할 수 있습니다.
지원되는 인증 유형에 대한 자세한 내용은
고객 인증 구성을 참조하십시오.
Adobe과 대상 플랫폼 사이에 전역 인증 시스템이 있고 Platform 고객이 대상에 연결하기 위해 인증 자격 증명을 제공할 필요가 없는 경우에만 이 API 끝점을 사용하여 자격 증명 구성을 만드십시오. 이 경우 /credentials API 끝점을 사용하여 자격 증명 구성을 만들어야 합니다.
글로벌 인증 시스템을 사용하는 경우 새 대상 구성을 만드는 경우에 대상 게재 구성에서 "authenticationRule":"PLATFORM_AUTHENTICATION"을(를) 설정해야 합니다.
Destination SDK에서 지원하는 모든 매개 변수 이름과 값은 대/소문자를 구분합니다. 대소문자 구분 오류를 방지하려면 설명서에 표시된 대로 매개 변수 이름과 값을 정확히 사용하십시오.
자격 증명 API 작업 시작 get-started
계속하기 전에 시작 안내서에서 필요한 대상 작성 권한 및 필수 헤더를 얻는 방법을 포함하여 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보를 검토하십시오.
자격 증명 구성 만들기 create
/authoring/credentials 끝점에 대한 POST 요청을 수행하여 새 자격 증명 구성을 만들 수 있습니다.
API 형식
POST /authoring/credentials
다음 요청은 페이로드에 제공된 매개 변수에 의해 정의된 새 자격 증명 구성을 만듭니다.
아래에서 각 탭을 선택하여 해당 페이로드를 확인합니다.
기본
기본 자격 증명 구성 만들기
| accordion |
| 요청 |
| code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"basicAuthentication":{
"url":"string",
"username":"string",
"password":"string"
}
}
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 layout-auto |
|
|
| 매개변수 |
유형 |
설명 |
url |
문자열 |
인증 공급자의 URL |
username |
문자열 |
자격 증명 구성 로그인 사용자 이름 |
password |
문자열 |
자격 증명 구성 로그인 암호 |
|
| accordion |
| 응답 |
| 성공한 응답은 새로 만든 자격 증명 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다. |
Amazon S3
자격 증명 구성 Amazon S3을(를) 만듭니다
| accordion |
| 요청 |
| code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
}
}
|
| table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
| 매개변수 |
유형 |
설명 |
accessId |
문자열 |
Amazon S3 액세스 ID |
secretKey |
문자열 |
Amazon S3 비밀 키 |
|
| accordion |
| 응답 |
| 성공한 응답은 새로 만든 자격 증명 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다. |
SSH
SSH 자격 증명 구성 만들기
| accordion |
| 요청 |
| code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"sshAuthentication":{
"username":"string",
"sshKey":"string"
}
}
|
| table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
| 매개변수 |
유형 |
설명 |
username |
문자열 |
자격 증명 구성 로그인 사용자 이름 |
sshKey |
문자열 |
SSH 인증을 사용하는 SFTP용 SSH 키 |
|
| accordion |
| 응답 |
| 성공한 응답은 새로 만든 자격 증명 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다. |
Azure 데이터 레이크 저장소
자격 증명 구성 Azure Data Lake Storage을(를) 만듭니다
| accordion |
| 요청 |
| code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"azureAuthentication":{
"url":"string",
"tenant":"string",
"servicePrincipalId":"string",
"servicePrincipalKey":"string"
}
}
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 layout-auto |
|
|
| 매개변수 |
유형 |
설명 |
url |
문자열 |
인증 공급자의 URL |
tenant |
문자열 |
Azure Data Lake 저장소 테넌트 |
servicePrincipalId |
문자열 |
Azure 데이터 레이크 스토리지에 대한 Azure 서비스 사용자 ID |
servicePrincipalKey |
문자열 |
Azure 데이터 레이크 스토리지에 대한 Azure 서비스 사용자 키 |
|
| accordion |
| 응답 |
| 성공한 응답은 새로 만든 자격 증명 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다. |
Azure Blob 저장소
자격 증명 구성 Azure Blob Storage을(를) 만듭니다
| accordion |
| 요청 |
| code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"azureConnectionStringAuthentication":{
"connectionString":"string"
}
}
|
| table 0-row-3 1-row-3 layout-auto |
|
|
| 매개변수 |
유형 |
설명 |
connectionString |
문자열 |
Azure Blob Storage 연결 문자열 |
|
| accordion |
| 응답 |
| 성공한 응답은 새로 만든 자격 증명 구성에 대한 세부 정보와 함께 HTTP 상태 200을 반환합니다. |
API 오류 처리 error-handling
Destination SDK API 엔드포인트는 일반적인 Experience Platform API 오류 메시지 원칙을 따릅니다. 플랫폼 문제 해결 안내서에서 API 상태 코드 및 요청 헤더 오류를 참조하십시오.
다음 단계 next-steps
이 문서를 읽고 나면 이제 자격 증명 끝점을 사용할 시점과 /authoring/credentials API 끝점을 사용하여 자격 증명 구성을 설정하는 방법을 알 수 있습니다. Destination SDK을 사용하여 대상을 구성하는 방법을 읽고 이 단계가 대상 구성 프로세스에 맞는 위치를 파악할 수 있습니다.