auth-methods change-state 명령어

auth-methods change-state 명령어

boundary auth-methods change-state는 주어진 ID의 OIDC 유형 인증 메서드(auth method)의 활성·가시성 상태를 바꾸는 명령어예요. OIDC 인증 메서드는 Inactive(비활성), Active Private(활성-비공개), Active Public(활성-공개) 상태를 가질 수 있어요.

출처: HashiCorp Boundary docs

본문

boundary auth-methods change-state 명령어는 주어진 ID의 OIDC 유형 인증 메서드의 활성·가시성 상태를 바꿔요.

OIDC 인증 메서드는 여러 상태 중 하나일 수 있어요: Inactive, Active Private, Active Public. OIDC 인증 메서드의 현재 상태는 엔드포인트가 요청에 어떻게 응답하는지에 영향을 주고, 때로는 엔드포인트 접근에 인증이 필요한지 여부에도 영향을 줘요.

  • MakeInactive는 OIDC 인증 메서드를 Active Private 또는 Active Public 상태에서 Inactive 상태로 전환해요.
  • MakePrivate는 OIDC 인증 메서드를 Inactive 또는 Active Public 상태에서 Active Private 상태로 전환해요. Inactive 상태에서 전환하는 경우, 설정이 유효할 때만 성공해요.
  • MakePublic는 OIDC 인증 메서드를 Inactive 또는 Active Private 상태에서 Active Public 상태로 전환해요. Inactive 상태에서 전환하는 경우, 설정이 유효할 때만 성공해요.

인증 메서드의 상태를 바꾸기 전에 Boundary는 인증 메서드 issuer의 공급자 discovery 문서를 가져와, 인증 메서드의 설정을 이 게시된 정보에 대해 검증하려 시도해요. Boundary가 설정을 검증할 수 없으면 오류가 반환되고 상태 변경은 성공하지 않아요.

예제 (Examples)

다음 예제는 OIDC 인증 메서드의 상태를 active-public으로 바꿔요.

$ boundary auth-methods change-state oidc -id amoidc_oHt4HQFCrN \
   -state active-public

예제 출력:

Auth Method information:

  Created Time:         Fri, 09 Sep 2022 11:11:55 MDT
  ID:                   amoidc_oHt4HQFCrN
  Name:                 auth0
  Type:                 oidc
  Updated Time:         Fri, 09 Sep 2022 11:41:33 MDT
  Version:              3

  Scope:
    ID:                 global
    Name:               global
    Type:               global

  Authorized Actions:
    no-op
    read
    update
    delete
    change-state
    authenticate

  Authorized Actions on Auth Method's Collections:
    accounts:
      create
      list
    managed-groups:
      create
      list

  Attributes:
    api_url_prefix:     https://e58fe114-7624-431c-994d-b6670e90b03J.boundary.hashicorp.cloud
    callback_url:       https://e58fe114-7624-431c-994d-b6670e90b03J.boundary.hashicorp.cloud/v1/auth-methods/oidc:authenticate:callback
    client_id:          zbaJLTZh3n14WqSV7qQ9onuIVRDaZdzx
    client_secret_hmac: Qc3i8NdnTP6rl4JANIg-a2GXgRW5rEKTp2ReIK_BOng
    issuer:             https://dev-1vdl8c0q.us.auth0.com/
    max_age:            0
    signing_algorithms: [RS256]
    state:              active-public

사용법 (Usage)

$ boundary auth-methods change-state oidc [options] [args]

명령 옵션 (Command options)

  • -id (string: "") - 작업을 수행할 oidc 유형 인증 메서드의 ID예요.

OIDC 인증 메서드 옵션 (OIDC auth method options)

  • -disable-discovered-config-validation - 공급자의 discovery URL에서 발견한 설정에 대해 주어진 인증 메서드 검증을 비활성화해요. 검증할 수 없는 인증 메서드를 업데이트하거나 상태를 바꿀 때마다 이 값을 지정해야 해요. 값을 지정하지 않는 것은 false로 설정하는 것과 동등해요. 기본값은 false예요.
  • -state (string: "") - 인증 메서드의 원하는 운영 상태예요. 인증 메서드에는 세 가지 상태가 있어요. inactive - 사용자는 비활성 인증 메서드로 인증할 수 없고, 비활성 인증 메서드는 인증되지 않은 사용자에게 나열되지 않아요. active-private - 사용자는 활성-비공개 인증 메서드로 인증할 수 있고, 활성-비공개 인증 메서드는 인증되지 않은 사용자에게 나열되지 않아요. active-public - 사용자는 활성-공개 인증 메서드로 인증할 수 있고, 활성-공개 인증 메서드는 인증되지 않은 사용자에게 나열돼요.

인증 메서드를 active-public 또는 active-private에서 inactive로 바꾸면, 요청이 처리되는 동안 인증 메서드의 설정이 수정되지 않는 한 진행 중이던 모든 인증은 성공해요.

boundary auth-methods change-state로 인증 메서드의 상태를 바꿀 때 Boundary는 -disable-discovered-config-validation 플래그를 사용해 공급자가 게시한 discovery 문서에 대한 검증을 비활성화해요. 이는 공급자가 잘못된 discovery 문서를 게시한 아주 드문 경우를 허용하기 위한 것이에요.

CLI 옵션 (CLI options)

명령어 고유 옵션 외에도 모든 Boundary CLI 명령어·하위 명령어에 공통으로 적용되는 옵션들이 있어요.

  • 연결 옵션 (Connection options)
  • 클라이언트 옵션 (Client options)
  • 출력 옵션 (Output options)
  • 환경 변수 (Environment variables)

더 알아보기 (Learn more)