API 키
API 키는 정확히 하나의 프로젝트에 속하며 스코프에 지정된 일을 합니다. 이름 붙은 모델과 오퍼레이션으로 더 좁히거나 하나의 조직으로 한정할 수 있습니다.
공개 키와 시크릿 키
두 가지 유형이 있으며 접두사로 구분합니다. 공개 키(pk_)는 브라우저에 담아 배포해도 안전합니다. 단독으로는 읽기 전용이며 게시된 콘텐츠를 반환하고, 로그인한 사용자가 있으면 그 사용자의 역할에 따른 스코프가 더해집니다. 시크릿 키(sk_)는 서버용이며, API는 브라우저의 Origin 헤더가 있는 요청에서는 시크릿 키를 거부합니다. 어느 유형이든 프로젝트 안에서 생성되며 그 프로젝트 하나만 대상으로 합니다.
스코프
스코프는 키가 가진 액세스의 종류를 정하며, 예를 들어 records:read나 오퍼레이션 실행이 해당합니다. 확인은 허용 목록 방식이므로, 키에 없는 스코프의 호출은 거부됩니다. 스코프는 호출을 허용할 뿐이며 쿼리가 반환하는 행을 넓히지 않습니다. 일부 스코프는 공개 키가 아예 가질 수 없으며, 요청하면 키를 만들 때 거부됩니다.
모델과 오퍼레이션으로 좁히기
키가 닿는 리소스를 정하는 선택기는 모델 액세스와 오퍼레이션 액세스, 두 가지입니다. 둘 다 기본값은 전체이며, 키의 스코프가 포괄하는 모든 것을 뜻하므로 좁히는 것은 선택 사항입니다. 특정 모델을 선택하면 그 외 모든 모델의 타입 지정 필드가 그 키가 보는 스키마에서 사라지고, 그 모델에 대한 호출은 거부됩니다. 특정 오퍼레이션만 선택하면 목록에 없는 오퍼레이션의 뮤테이션은 인트로스펙션을 포함해 키의 스키마에 나타나지 않습니다.
하나의 조직으로 한정
키는 생성할 때 조직 하나로 한정할 수 있습니다. 이 키는 그 조직, 그 아래 모든 조직, 프로젝트 전체에서 공유되는 행을 읽으며 쓰기는 자기 조직에만 합니다. 스코프를 하나 이상 지정해야 하고, 키를 발급할 수 없으며, 조직이 삭제되면 함께 삭제됩니다.
교체와 이후 변경
키를 교체하면 이전 시크릿이 24시간 동안 계속 동작합니다. 해지하면 모든 시크릿이 즉시 종료됩니다. 기존 키에서 스코프, 허용 모델, 이름은 편집할 수 있고 저장하는 즉시 적용됩니다. 키 유형, 한정, 만료는 생성할 때 고정됩니다.