Api키인증

인터페이스 ApiKeyAuth

사용자가 자신의 제어 하에 API 키를 managed 수 있는 기능을 노출합니다.

속성

추상 val 앱: 앱

이 인스턴스가 연결된 앱입니다.

이 인스턴스가 연결된 사용자입니다.

추상 일시 중단 fun create(name: 문자열): ApiKey

사용자로 인증하는 데 사용할 수 있는 사용자 API 키를 생성합니다. 키 값은 이때만 표시되므로 유지되어야 합니다. 키는 생성되면 활성화됩니다. disable 메서드를 호출하여 비활성화할 수 있습니다.

추상 일시 중단 fun 삭제(id: BsonObjectId)

사용자가 생성한 특정 API 키를 삭제합니다. 삭제된 키가 없으면 조용히 반환합니다.

추상 일시 중단 fun 비활성화(id: BsonObjectId)

사용자가 생성한 특정 API 키를 삭제합니다. 제공된 키가 없으면 함수가 정상적으로 완료됩니다.

추상 일시 중단 fun 활성화(id: BsonObjectId)

사용자가 생성한 특정 API 키를 활성화합니다.

추상 일시 중단 fun 가져오기(id: BsonObjectId): ApiKey?

사용자와 연결된 특정 사용자 API 키를 가져옵니다.

추상 일시 중단 fun fetchAll(): 목록<ApiKey>

사용자와 연결된 모든 API 키를 가져옵니다. 키를 찾을 수 없으면 빈 목록을 반환합니다.