콘텐츠로 이동

API 키 발급 (자동화용 계정 추가)

POST
/api/core/organization/{organizationId}/members/by-key
curl --request POST \
--url https://www.easterad.com/api/core/organization/example/members/by-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "roleId": "example", "name": "example", "description": "example", "ipWhitelist": [ "example" ], "rateLimit": { "requests": 1, "windowSeconds": 1 }, "expiresAt": "example" }'
organizationId
required
string
Media typeapplication/json
object
roleId
required
string
name
required
string
description
string
ipWhitelist
Array<string>
rateLimit
object
requests
required
integer
>= 1
windowSeconds
required
integer
>= 60
expiresAt
string
/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/
Examplegenerated
{
"roleId": "example",
"name": "example",
"description": "example",
"ipWhitelist": [
"example"
],
"rateLimit": {
"requests": 1,
"windowSeconds": 1
},
"expiresAt": "example"
}

성공

Media typeapplication/json
object
apiKey
required
string
_id
required
string
email
required
string
description
string
expiresAt
string
/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/
profile
required
object
firstName
string
lastName
string
fullName
required
string
picture
string
/^https?://(?:[^\s/:?#]+|\[[0-9A-Fa-f:.]+\])(?::\d{1,5})?(?:[/?#][^\s]*)?$/
locale
required
string
timezone
required
string
roleName
required
string
roleId
required
string
joinedAt
required
string
/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/
Examplegenerated
{
"apiKey": "example",
"_id": "example",
"email": "example",
"description": "example",
"expiresAt": "example",
"profile": {
"firstName": "example",
"lastName": "example",
"fullName": "example",
"picture": "example",
"locale": "example",
"timezone": "example"
},
"roleName": "example",
"roleId": "example",
"joinedAt": "example"
}

오류 — 공통 오류 응답. 인증 단계 오류 코드는 문서의 “인증” 페이지를 참조.

Media typeapplication/json
object
statusCode
required
number
code
required

BadRequest | Unauthorized | Forbidden | NotFound | Conflict | TooManyRequests | InternalServerError | ServiceUnavailable

string
message
required
string
reason

선택 상세 사유. 예: CREATIVE_NOT_READY

string
assetId

관련 소재 ID (선택)

string
Examplegenerated
{
"statusCode": 1,
"code": "example",
"message": "example",
"reason": "example",
"assetId": "example"
}