객체
ApiKeyCreate
필드
namestring필수length ≥ 1, length ≤ 64
rolestring기본값: "editor"
data_profilestring | null키의 데이터 프로필. 지정하지 않으면 키는 조직의 기본 프로필을 받아요. 데이터 프로필은
admin역할에 적용되지 않아요. 관리자 키는 조직의 모든 데이터를 보며,full이외의 프로필을 지정하면400 api_keys.data_profile_not_applicable오류를 반환해요.expires_atstring (date-time) | null키의 만료 시각(ISO 8601, 미래 시각).
null이거나 값이 없으면 키가 만료되지 않아요.scopesarray of ApiKeyScope | null키의 스코프. 생략하면 역할에 따라 정해져요:
admin역할에는read,write,admin,editor와verifier역할에는read,write,viewer역할에는read스코프가 주어져요.system스코프는 설치 환경 관리자만 발급해요. 세분화된resource:action스코프(ApiKeyScope)도 받을 수 있으며, 이전 스코프인read,write,admin은 스코프 집합으로 확장돼요.collection_idsarray of integer | null키를 조직의 이 컬렉션들로 제한해요. 카드, 검색, 답변, 이벤트는 역할과 데이터 프로필에 더해 이 컬렉션 안에서만 동작해요. 값이 없거나 빈 목록이면 제한이 없어요. 호출하는 키 자체가 컬렉션으로 제한되어 있으면 새 키도 그 키의 컬렉션 안에서만 지정할 수 있어요. 이때 이 필드가 없으면 새 키는 호출하는 키의 컬렉션을 받아요. 빈 목록이나 그 키의 목록 밖에 있는 컬렉션을 보내면
400 api_keys.invalid_collections오류를 반환해요.items ≤ 100
allowed_cidrsarray of string | null키를 사용할 수 있는 네트워크(예:
10.0.0.0/8,2001:db8::/32). 단일 주소는 주소 하나로 된 네트워크로 봐요. 다른 주소에서 보낸 요청은403 api_keys.ip_not_allowed오류를 반환해요. 값이 없으면 제한이 없어요.items ≤ 50