키클로크 REST API 사용을 위한 서버 구성하기

목차

1. 키클로크 구성하기
2. 리엠(Realm) 생성하기
3. 클라이언트(Client) 생성하기
4. 인증(Authentication) 구성하기
5. 역할(Roles) 생성하기
6. 사용자(User) 생성하기
7. 그룹(Group) 생성하기
8. 세션(Session) 관리하기
9. 이벤트(Events) 모니터링하기
10. 인증(Authentication) 플로우 생성하기

키클로크 구성하기

😃 1. 리엠(Realm) 생성하기

키클로크를 구성하기 위해서는 먼저 리엠을 생성해야 합니다. 리엠은 조직 및 기업의 개념으로 생각할 수 있습니다. 영희할 때 많이들 들어보셨을 아마존이나 마이크로소프트와 같은 조직을 예시로 들 수 있습니다. 리엠을 생성하기 위해선 Json 파일을 업로드할 수 있는 옵션이 제공됩니다. 여러 개발자들이 비슷한 구성이 필요한 경우, 한 명의 개발자가 구성을 설정하고 Json 파일로 내보내어 다른 개발자들이 해당 구성을 가져와 사용할 수 있습니다. 이를 통해 구성을 공유하고 효율적으로 설정할 수 있습니다. Json 파일을 생성하고 업로드하면 리엠 이름이 자동으로 가져와집니다. 기본적으로 리엠은 마스터(Master) 리엠을 제공하지만 필요에 따라 새로운 리엠을 생성할 수 있습니다.

😃 2. 클라이언트(Client) 생성하기

클라이언트는 조직에서 제공하는 애플리케이션의 목록입니다. 마이크로소프트에서는 마이크로소프트 팀즈(Microsoft Teams)나 마이크로소프트 아웃룩(Microsoft Outlook)과 같은 별개의 제품들을 예시로 들 수 있습니다. 저희는 퀴커스 어플리케이션에 대한 클라이언트를 생성할 것입니다. 클라이언트 생성 시, 인증과 권한 부여를 활성화시킬지 여부를 선택할 수 있습니다. 인증에만 활성화할 예정이며, 권한은 퀴커스 어플리케이션에서 구현된 후에 진행할 예정입니다. 클라이언트 생성 시, 표준 플로우와 직접 액세스 사용 가능한 두 가지 인증 플로우가 제공됩니다. 표준 플로우는 키클로크의 로그인 페이지로 리디렉션됩니다. 직접 액세스는 주로 REST API 호출을 위해 사용됩니다. 우리가 REST API 호출을 구현할 예정이므로, 해당 옵션을 선택할 것입니다.

😃 3. 인증(Authentication) 구성하기

인증은 키클로크에서 가장 중요한 부분입니다. 클라이언트 인증을 활성화하지 않으면 키클로크를 사용하는 의미가 없어지기 때문에, 반드시 활성화해야 합니다. 클라이언트 생성 시, 인증 플로우를 확인할 수 있습니다. 이 중에서는 표준 플로우와 직접 액세스가 주로 사용됩니다. 표준 플로우는 키클로크의 로그인 템플릿으로 리디렉션됩니다. 직접 액세스는 REST API 호출을 위해 주로 사용됩니다. 리다이렉트 URI가 필요한데, 퀴커스 어플리케이션은 로컬에서 실행되므로 8080 포트를 선택합니다. 그 외의 속성은 지금은 사용하지 않을 것이므로, 기본값으로 설정합니다.

😃 4. 역할(Roles) 생성하기

키클로크에서 역할은 조직 전체에 대한 글로벌한 권한을 설정할 수 있습니다. 클라이언트별로 역할을 생성하는 것과는 다른 개념입니다. 여기서는 조직 전체에 대한 역할만 생성할 예정입니다. 생성한 역할은 리엠 내의 모든 클라이언트에서 사용할 수 있습니다.

😃 5. 사용자(User) 생성하기

키클로크에서 사용자는 애플리케이션에 접근할 수 있는 사용자 목록입니다. 사용자를 생성하려면 사용자 이름과 인증에 필요한 자격 증명(비밀번호)을 설정해야 합니다. 사용자를 생성한 후에는 기본 역할이 자동으로 할당되며, 기본 역할에는 다른 역할들이 포함될 수 있습니다. 필요에 따라 사용자에게 다른 역할을 부여할 수 있습니다.

😃 6. 그룹(Group) 생성하기

그룹은 사용자들을 한데 모아 관리할 수 있도록 도와주는 개념입니다. 특정 그룹에 속한 사용자들에 대해 일괄적인 설정이 가능합니다. 그룹을 생성하고 사용자를 추가하여 그룹 단위로 사용자를 관리할 수 있습니다.

😃 7. 세션(Session) 관리하기

세션은 사용자의 로그인 세션을 관리하는 기능입니다. 현재 로그인한 사용자들의 세션 상태를 확인하거나 세션을 강제로 종료할 수 있습니다.

😃 8. 이벤트(Events) 모니터링하기

이벤트 기능은 키클로크에서 발생하는 이벤트를 모니터링할 수 있는 기능입니다. 현재는 사용하지 않을 예정이므로, 자세한 내용은 다음 비디오에서 확인하겠습니다.

😃 9. 인증(Authentication) 플로우 생성하기

인증 플로우는 키클로크에서 사용할 수 있는 다양한 인증 방식을 설정할 수 있습니다. 필요에 따라 새로운 플로우를 생성할 수도 있습니다. 직접 액세스 플로우의 동작 방식을 확인하기 위해 예시로 보여드리겠습니다.

하이라이트

• 키클로크를 통해 사용자 인증 및 권한 부여 설정할 수 있습니다.
• 리엠을 사용하여 조직의 구성을 관리할 수 있습니다.
• 클라이언트를 생성하여 애플리케이션 관리할 수 있습니다.
• 역할을 생성하여 사용자에게 권한을 부여할 수 있습니다.
• 그룹을 통해 사용자를 관리할 수 있습니다.
• 세션을 관리하여 사용자의 로그인 상태를 확인하고 종료할 수 있습니다.
• 이벤트를 모니터링하여 키클로크의 활동을 추적할 수 있습니다.
• 다양한 인증 플로우를 설정하여 인증 방식을 커스터마이징할 수 있습니다.

자주 묻는 질문

Q: 키클로크에서 리엠이란 무엇인가요? A: 리엠은 조직이나 기업의 개념으로, 사용자 및 클라이언트 등을 관리하기 위한 단위입니다.

Q: 인증과 권한 부여의 차이점은 무엇인가요? A: 인증은 사용자의 신원을 확인하는 과정을 의미하며, 권한 부여는 인증된 사용자에게 특정 작업을 수행할 수 있는 권한을 부여하는 과정입니다.

Q: 역할과 그룹의 차이점은 무엇인가요? A: 역할은 권한을 부여할 수 있는 개념이고, 그룹은 사용자들을 묶어서 관리할 수 있는 개념입니다. 역할은 조직 전체에 대한 권한을 설정하고, 그룹은 특정 사용자들을 한 그룹으로 묶어서 일괄적인 설정을 적용할 수 있습니다.

Q: 세션을 강제로 종료할 수 있나요? A: 네, 관리자는 키클로크에서 세션을 관리하여 사용자의 세션을 확인하고 강제로 종료할 수 있습니다.

Q: 이벤트 모니터링이 왜 필요한가요? A: 이벤트 모니터링은 키클로크에서 발생하는 활동을 추적하고 모니터링할 수 있는 기능입니다. 시스템의 보안 감시와 데이터 분석 등에 활용될 수 있습니다.

Q: 초기 비밀번호 설정은 어떻게 할 수 있나요? A: 생성한 사용자의 비밀번호 설정을 임시 비밀번호로 유지할 것인지, 초기 비밀번호를 사용자가 직접 설정해야 하는지 선택할 수 있습니다.

자세한 내용은 아래의 자원을 참고하세요:

• 키클로크 공식 문서