API를 사용하여 인스턴스 백업

관리 API를 사용하여 App ID 인스턴스를 백업하려면 App ID API에 요청을 보내 App ID 인스턴스에 대한 설정 정보가 포함된 파일을 생성하는 스크립트를 작성하세요. 이러한 파일은 보조 리젼에서 App ID 인스턴스를 복원하는 데 필요하므로 안전한 위치에 저장하십시오.

App ID 인스턴스의 설정 (예: 유스 케이스에 필요한 사항) 을 기반으로 백업 설정을 정의하십시오. 예를 들어, 다음 시나리오에서는 다음 설정으로 App ID 인스턴스를 구성합니다.

• 암호 정책 (예: 사용자가 세 번 연속으로 잘못된 암호를 입력하는 경우 60분 동안 사용자 프로파일 잠금)
• SAML 구성

관리 API를 사용하여 이러한 사용자 설정을 검색하려면 다음을 전송하십시오.

• 엔드포인트에 GET 요청을 보내면 /management/v4/<tenantId>/config/cloud_directory/advanced_password_management 엔드포인트에 요청하여 고급 비밀번호 관리의 구성을 가져옵니다.

curl -X 'GET' \
  'https://<region>.appid.cloud.ibm.com/management/v4/<tenantId>/config/cloud_directory/advanced_password_management' \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer <IAM_Token>'

• 엔드포인트에 GET 요청을 보내면 /management/v4/<tenantId>/config/idps/saml 엔드포인트에 요청하여 상태 및 자격 증명을 포함하는 SAML ID 공급자 구성을 가져옵니다.

curl -X 'GET' \
  'https://<region>.appid.cloud.ibm.com/management/v4/<tenantId>/config/idps/saml' \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer <IAM_Token>'

App ID 인스턴스의 구성 설정 백업을 보존하는 것 외에도 Cloud Directory 사용자 및 사용자 프로파일의 백업을 생성해야 합니다. 이 태스크를 수행하려면 관리 API를 사용하는 것이 좋습니다.

• Cloud Directory 사용자를 내보내려면 cloud_directory/export/all API 엔드포인트를 사용하십시오. 내보내기를 다운로드하려면 cloud_directory/export/download API를 사용하십시오. 관리 API를 사용하여 Cloud Directory 사용자를 내보내는 방법에 대한 자세한 정보는 모든 사용자 내보내기 문서를 참조하십시오.
• 사용자 프로파일을 내보내려면 users/export 엔드포인트를 사용하십시오.
• 이러한 두 개의 내보내기 API는 두 개의 백업 파일을 생성합니다. 이 백업 파일은 나중에 복원 프로세스에서 사용하기 위해 안전하게 저장해야 합니다.

Terraform및 API를 사용하여 인스턴스 백업

Terraform을 사용하여 App ID 설정을 백업하기 위해 Terraform 스크립트를 작성하여 App ID 인스턴스에 대한 설정 정보를 포함하는 파일을 생성할 수 있습니다. 이러한 파일을 사용하여 보조 리젼에서 App ID 인스턴스를 복원해야 하므로 안전한 위치에 저장하십시오.

App ID 인스턴스의 설정 (예: 유스 케이스에 필요한 사항) 을 기반으로 백업 설정을 정의하십시오. 예를 들어, 다음 시나리오에서는 다음 설정으로 App ID 인스턴스를 구성합니다.

• 암호 정책 (예: 사용자가 세 번 연속으로 잘못된 암호를 입력하는 경우 60분 동안 사용자 프로파일 잠금)
• SAML 구성

다음 테라폼 스크립트를 사용하여 현재 구성을 검색하고 이를 파일에 저장할 수 있습니다.

terraform {
  required_providers {
    ibm = {
      source = "IBM-Cloud/ibm"
      version = ">= 1.12.0"
    }
  }
}

variable "tenant_id" {
  type = string
  default = "<<YOUR TENANT ID>>"
}

variable "region" {
  type = string
  default = "<<THE REGION YOUR TENANT IS LOCATED>>"
}

provider "ibm" {
  region = var.region
  ibmcloud_api_key = "<<API KEY TO ACCESS APP ID INSTANCE>>"
}

##### ---------- Getting the configuration from your App ID instance ---------- #####

# Get Settigs about Password's rules
data "ibm_appid_apm" "app" {
    tenant_id = var.tenant_id   
}

# Get SAML config
data "ibm_appid_idp_saml" "saml" {
    tenant_id = var.tenant_id
}

##### ---------- Saving the App ID configuration to files ---------- #####

resource "local_file" "app_config" {
    content  = jsonencode(data.ibm_appid_apm.app)
    filename = "${path.module}/backup_configurations/app_config.json"
}

resource "local_file" "saml_config" {
    content  = jsonencode(data.ibm_appid_idp_saml.saml)
    filename = "${path.module}/backup_configurations/saml_config.json"
}

이전 시나리오에서 백업을 포함하는 파일은 로컬로 저장됩니다. 그러나 다음과 같이 원하는 다른 저장 위치에 저장할 수 있습니다 IBM Cloud Object Storage.

Cloud Directory 사용자 및 사용자 프로파일의 백업을 생성하려면 관리 API를 사용하는 것이 좋습니다.

• Cloud Directory 사용자를 내보내려면 cloud_directory/export/all API 엔드포인트를 사용하십시오. 내보내기를 다운로드하려면 cloud_directory/export/download API를 사용하십시오. 관리 API를 사용하여 Cloud Directory 사용자를 내보내는 방법에 대한 자세한 정보는 모든 사용자 내보내기 를 참조하십시오.
• 사용자 프로파일을 내보내려면 users/export 엔드포인트를 사용하십시오.
• 이러한 두 개의 내보내기 API는 두 개의 백업 파일을 생성하며, 이 파일은 나중에 복원 프로세스에서 사용하기 위해 저장해야 합니다.

API를 사용하여 App ID 인스턴스 복원

먼저 보조 리젼에서 App ID 의 새 인스턴스를 수동으로 프로비저닝해야 합니다. 그런 다음 백업 파일을 읽고 관리 API 요청을 사용하여 보조 리젼에서 App ID 인스턴스를 설정하여 App ID 설정을 복원할 수 있습니다.

백업 섹션에 포함된 시나리오를 계속 진행하면서 다음을 관리 API로 전송하여 SAML 구성 및 비밀번호 정책을 복원할 수 있습니다:

• 엔드포인트에 PUT 요청을 보내 /management/v4/<tenantId>/config/cloud_directory/advanced_password_management 엔드포인트에 PUT 요청을 보내 고급 비밀번호 관리 구성을 업데이트합니다. 백업에 저장된 데이터를 HTTP 요청 본문으로 전달합니다.

curl -X 'PUT' \
  'https://<region>.appid.cloud.ibm.com/management/v4/<tenantId>/config/cloud_directory/advanced_password_management' \
  --header 'accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <IAM_Token>' \
  -d '<Data_from_your_backup_file>'

• 엔드포인트에 PUT 요청을 보내 /management/v4/<tenantId>/config/idps/saml 엔드포인트에 PUT 요청을 보내 SAML IdP 구성을 업데이트합니다. 백업에 저장된 데이터를 HTTP 요청 본문으로 전달합니다.

curl -X 'PUT' \
  'https://<region>.appid.cloud.ibm.com/management/v4/<tenantId>/config/idps/saml' \
  --header 'accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <IAM_Token>' \
  -d '<Data_from_your_backup_file>'

사용 가능한 경우 Cloud Directory 사용자 및 해당 프로파일의 백업을 복원하려면 관리 API를 사용하는 것이 좋습니다.

• Cloud Directory 사용자를 가져오려면 cloud_directory/import/all API 엔드포인트를 사용하십시오. 관리 API를 사용하여 Cloud Directory 사용자를 가져오는 방법에 대한 자세한 정보는 모든 사용자 가져오기 문서를 참조하십시오.
• 사용자 프로파일을 가져오려면 users/import 엔드포인트를 사용하십시오.

Terraform및 API를 사용하여 App ID 인스턴스 복원

Terraform및 관리 API의 조합을 사용하여 App ID 인스턴스를 복원하는 경우 첫 번째 단계는 보조 리젼에서 App ID 의 새 인스턴스를 프로비저닝하기 위해 Terraform 스크립트를 작성하는 것입니다. 그런 다음 백업 파일을 읽고 terraform 명령을 사용하여 보조 리젼에서 App ID 인스턴스를 설정하여 App ID 설정을 복원할 수 있습니다.

백업 섹션에 포함된 시나리오를 계속 진행하면서 다음 스크립트를 사용하여 SAML 구성 및 비밀번호 정책을 복원할 수 있습니다:

terraform {
  required_providers {
    ibm = {
      source = "IBM-Cloud/ibm"
      version = ">= 1.12.0"
    }
  }
}

variable "backup_region" {
  type = string
  default = "<<REGION WHERE TO CREATE THE NEW APPID INSTANCE>>"
}

variable "backup_appid_instance_name" {
  type = string
  default = "<<THE NAME OF THE NEW APPID INSTANCE>>"
}

provider "ibm" {
  region = var.backup_region
  ibmcloud_api_key = "<<API KEY TO ACCESS APP ID INSTANCE>>"
}

##### ---------- Creating an AppID instance in a secondary location ---------- #####

data "ibm_resource_group" "group" {
  name = "Default"
}

resource "ibm_resource_instance" "backup_appid_instance" {
  name              = var.backup_appid_instance_name
  service           = "appid"
  plan              = "graduated-tier"
  location          = var.backup_region
  resource_group_id = data.ibm_resource_group.group.id
  tags              = ["backup_instance", "backup_of_appid_from_primary_region"]
}

##### ---------- Getting the configuration from the local backups ---------- #####

locals {
	app_config = jsondecode(file("${path.module}/backup_configurations/app_config.json"))
	saml_config = jsondecode(file("${path.module}/backup_configurations/saml_config.json"))
}


##### ---------- Restoring the App ID configuration into the new App ID instance ---------- #####


# Setting SAML config in the new App ID Instance
resource "ibm_appid_idp_saml" "saml" {
  tenant_id = resource.ibm_resource_instance.backup_appid_instance.guid
  is_active = local.saml_config.is_active
  config {
    entity_id = local.saml_config.config[0].entity_id
    sign_in_url = local.saml_config.config[0].sign_in_url
    display_name = local.saml_config.config[0].display_name
    encrypt_response = local.saml_config.config[0].encrypt_response
    sign_request = local.saml_config.config[0].sign_request
    certificates = [local.saml_config.config[0].certificates[0]]
  }
}

# Setting password policies config in the new App ID Instance
resource "ibm_appid_apm" "apm" {
  tenant_id = resource.ibm_resource_instance.backup_appid_instance.guid
  enabled = local.app_config.enabled
  prevent_password_with_username = local.app_config.prevent_password_with_username

  password_reuse {
    enabled = local.app_config.password_reuse[0].enabled
    max_password_reuse = local.app_config.password_reuse[0].max_password_reuse
  }

  password_expiration {
    enabled = local.app_config.password_expiration[0].enabled
    days_to_expire = local.app_config.password_expiration[0].days_to_expire
  }

  lockout_policy {
    enabled = local.app_config.lockout_policy[0].enabled
    lockout_time_sec = local.app_config.lockout_policy[0].lockout_time_sec
    num_of_attempts = local.app_config.lockout_policy[0].num_of_attempts
  }

  min_password_change_interval {
    enabled = local.app_config.min_password_change_interval[0].enabled
    min_hours_to_change_password = local.app_config.min_password_change_interval[0].min_hours_to_change_password
  }
}

Cloud Directory 사용자 및 사용자 프로파일을 복원하려면 관리 API를 사용하는 것이 좋습니다.

• Cloud Directory 사용자를 가져오려면 cloud_directory/import/all API 엔드포인트를 사용하십시오. 관리 API를 사용하여 Cloud Directory 사용자를 가져오는 방법에 대한 자세한 정보는 모든 사용자 가져오기 를 참조하십시오.
• 사용자 프로파일을 가져오려면 users/import 엔드포인트를 사용하십시오.