본문으로 건너뛰기
Sursa Developers

객체

ApiKeyUpdate

키 변경 사항. 전달하지 않은 필드는 그대로 유지되며, data_profile 필드는 선택 사항이에요. 빈 scopes 목록은 역할에 따른 스코프를, 빈 collection_ids와 allowed_cidrs 값은 제한 없음을 뜻하고, expires_at 값을 null로 설정하면 키가 만료되지 않아요. 컬렉션으로 제한된 키는 컬렉션 제한(collection_ids)을 없애거나 넓힐 수 없어요.

필드

  • data_profilestring

    키의 새 데이터 프로필. 데이터 프로필은 admin 역할에 적용되지 않으므로, 관리자 키에 full 이외의 프로필을 지정하면 400 api_keys.data_profile_not_applicable 오류를 반환해요.

  • scopesarray of ApiKeyScope

    키의 스코프. system 스코프는 API로 발급되지 않아요.

  • collection_idsarray of integer

    키를 이 컬렉션들로 제한해요. 빈 목록은 제한 없음을 뜻해요. 호출하는 키 자체가 컬렉션으로 제한되어 있으면 그 키의 컬렉션 안에 있는 키만 보고 바꿀 수 있으며(다른 키는 404 api_keys.not_found 오류를 반환해요), 그 키의 컬렉션으로 이루어진 비어 있지 않은 목록만 지정할 수 있어요. 빈 목록이나 그 키의 목록 밖에 있는 컬렉션을 보내면 400 api_keys.invalid_collections 오류를 반환해요. 이 필드가 없으면 키의 컬렉션은 그대로 유지돼요.

    items ≤ 100

  • allowed_cidrsarray of string

    키를 사용할 수 있는 네트워크.

    items ≤ 50

  • expires_atstring (date-time) | null

    만료 시각(미래 시각). null이면 키가 만료되지 않아요.

사용처