Cato API로 관리자 관리

이 문서에서는 Cato 관리 애플리케이션의 관리자와 관리자 역할을 관리할 수 있는 다양한 Cato API에 대해 설명합니다. 이 API는 리셀러 계정과 일반 계정 모두에 대한 관리자 관리를 지원합니다.

관리자 구성 API 추가하기

addAdmin 구성 API는 Cato 관리 애플리케이션에서 계정에 새 관리자를 생성합니다.

관리자 입력 파라미터 추가하기

계정 ID (필수)

관리자 인수 추가하기

다음은 addAdmin 구성 API의 인수입니다.

이름: 관리자의 첫 번째 이름 (최대 255자) - 이 필드는 필수입니다
성: 관리자의 마지막 이름 (최대 255자) - 이 필드는 필수입니다
이메일: 관리자의 이메일 주소, 고유 (최대 255자) - 이 필드는 필수입니다
비밀번호가 절대 만료되지 않음: 불린 값 (true/false). 값이 true로 설정된 경우 관리자의 비밀번호는 만료되지 않습니다 - 이 필드는 필수입니다
다단계 인증 활성화됨: 불린 값 (true/false). 값이 true로 설정된 경우, 관리자는 Cato 관리 애플리케이션에 로그인하려면 MFA 코드를 사용해야 합니다 - 이 필드는 필수입니다
관리된 역할: updateAdminRoleInput 배열. 관리자에게 할당된 역할을 정의합니다. 리셀러 관리자에게 관리 계정에 대해 할당된 역할을 정의합니다. API 호출을 위한 이 필드가 정의되지 않으면 관리자는 뷰어 역할 (ID 2)에 할당됩니다.
- 관리자에게 편집자 역할을 할당하려면 ID 1을 사용합니다
리셀러 역할: updateAdminRoleInput 배열 (리셀러 관리자에게만 관련됨). 리셀러 계정을 위한 관리자가 할당받은 역할을 정의합니다. 이 필드가 API 호출에 대해 정의되지 않으면 관리자는 리셀러 계정을 위한 뷰어 역할을 할당받습니다.

관리자가 생성되면, 흐름은 관리자가 Cato 관리 애플리케이션에서 생성된 경우와 동일합니다.

계정이 사용자 이름과 비밀번호로 관리자가 로그인할 수 있도록 정의되어 있으면, 관리자는 계정을 활성화하고 비밀번호를 설정하는 링크가 포함된 환영 이메일을 받게 됩니다.

관리자 API 예시 추가하기

mutation  {
  관리(accountId:"xxxxxx") {
    관리자 추가 입력: {
      이름 : "dani2",
      성 : "din2"
      이메일: "danidin5@4catonetworks.com",
      비밀번호가 절대 만료되지 않음: true,
      다단계 인증 활성화됨: false,
      관리된 역할: [{ 역할: { id: 2}}, {역할: {id:3}}]}
    ) {
        관리자ID
    }
  }
}

관리자 구성 API 업데이트

updateAdmin 구성 API는 관리자 정보(관리자의 이메일과 ID는 업데이트할 수 없음)를 업데이트할 수 있습니다.

관리자 입력 파라미터 업데이트

계정 ID (필수)

관리자 인수 업데이트

관리자ID (필수)
이름: 관리자의 첫 번째 이름
성: 관리자의 마지막 이름
비밀번호가 절대 만료되지 않음: 불린 값 (true/false). 값이 true로 설정된 경우 관리자의 비밀번호는 만료되지 않습니다
다단계 인증 활성화됨: 불린 값 (true/false). 값이 true로 설정된 경우 관리자는 Cato 관리 애플리케이션에 로그인하려면 MFA 코드를 사용해야 합니다
관리된 역할: updateAdminRoleInput 배열. 관리자에게 할당된 역할을 정의합니다. 리셀러 관리자에게 관리 계정에 대해 할당된 역할을 정의합니다.
리셀러 역할: updateAdminRoleInput 배열 (리셀러 관리자에게만 관련됨). 리셀러 계정을 위한 관리자가 할당받은 역할을 정의합니다.

API 예시 업데이트 관리자

mutation {
  관리(accountId: "26") {
    관리자 업데이트 
      관리자ID: "28876"
      입력: {
        이름: "샘플"
        성: "관리자"
        비밀번호가 절대 만료되지 않음: true
        관리된 역할: [{ 역할: { id: 1 }}]}

    ) {
      관리자ID
    }
  }
}

업데이트 관리자.png

관리자 제거

removeAdmin 구성 API는 계정에서 관리자를 삭제할 수 있습니다.

관리자 인수 제거

계정 ID (필수)
관리자ID (필수)

API 예시 관리자 제거

mutation  {
  관리(accountId:"XXX") {
    관리자 제거 관리자ID:YYY
    ) {
        관리자ID
    }
  }
}

관리자 읽기 전용 API

admins 읽기 전용 API 쿼리는 계정의 모든 관리자에 대한 데이터(id, 이메일, 이름, 성, passwordNeverExpires, mfaEnabled, 역할)를 반환합니다.

관리자 입력 파라미터

계정 ID (필수)

관리자 인수

ID: 관리자의 Cato ID
이름: 관리자의 첫 번째 이름
성: 관리자의 마지막 이름
이메일: 이메일 주소
비밀번호가 절대 만료되지 않음: 불린 값 (true/false). 값이 true로 설정된 경우 관리자의 비밀번호는 만료되지 않습니다
다단계 인증 활성화됨: 불린 값 (true/false). 값이 true로 설정된 경우 관리자는 Cato 관리 애플리케이션에 로그인하려면 MFA 코드를 사용해야 합니다
관리된 역할: updateAdminRoleInput 배열. 관리자에게 할당된 역할을 정의합니다. 리셀러 관리자에게 관리 계정에 대해 할당된 역할을 정의합니다.
리셀러 역할: updateAdminRoleInput 배열 (리셀러 관리자에게만 관련됨). 리셀러 계정을 위한 관리자가 할당받은 역할을 정의합니다.

API 예시 관리자

query {
  관리자(accountID: XXX) {
    항목들 {
      id
      이메일
      이름
      성
      수정날짜
      생성날짜
      비밀번호가 절대 만료되지 않음
      다단계 인증 활성화됨
      관리된 역할 {
        역할 {
          id
          이름
        }
	리셀러 역할 {
        역할 {
          id
          이름
        }
      }
    }
  }
}

관리자들.png

관리자 읽기 전용 API 가져오기

getAdmin 읽기 전용 API 쿼리는 단일 계정 관리자에 대한 정보를 반환합니다: 이메일, 이름, 성, passwordNeverExpires, mfaEnabled, 역할 등

관리자 입력 파라미터 가져오기

계정 ID (필수)
관리자ID (필수)

관리자 인수 가져오기

이름: 관리자의 첫 번째 이름
성: 관리자의 마지막 이름
이메일: 이메일 주소
비밀번호가 절대 만료되지 않음: 불린 값 (true/false). true로 설정된 경우, 관리자의 비밀번호는 만료되지 않습니다
다단계 인증 활성화됨: 불린 값 (true/false). true로 설정된 경우, 관리자는 Cato 관리 애플리케이션에 로그인하려면 MFA 코드를 사용해야 합니다
관리된 역할: updateAdminRoleInput 배열. 관리자에게 할당된 역할을 정의합니다. 리셀러 관리자에게 관리 계정에 대해 할당된 역할을 정의합니다.
리셀러 역할: updateAdminRoleInput 배열 (리셀러 관리자에게만 관련됨). 리셀러 계정을 위한 관리자가 할당받은 역할을 정의합니다.

API 예시 가져오기

query {
  관리자 가져오기(accountId: "XXX", adminID: YYY) {
    id
    이름
    성
    이메일
    비밀번호가 절대 만료되지 않음
    다단계 인증 활성화됨
    생성날짜
    관리된 역할 {
      역할 {
        id
        이름
      }
    }
    리셀러 역할 {
      역할 {
        id
        이름
      }
    }
  }
}

관리자 가져오기.png

계정 역할 읽기 전용 API

accountRoles API 읽기 전용 쿼리는 계정에 정의된 모든 역할(사용자 정의 역할 및 사전 정의된 역할)을 반환합니다. 이것은 고객이 addAdmin API를 사용할 때 필요합니다. 이 API는 역할 ID를 표시합니다 (addAdmin API에서 사용됨).

계정 역할 입력 파라미터

계정 ID
accountType
- 일반 (일반 또는 관리 계정 역할에 대해)
- 리셀러 (리셀러 계정 역할에 대해)

계정 역할 인수

   id: ID! (역할의 id)
   이름: 문자열! (역할의 이름)
   설명: 문자열 (설명)
  	사전 정의됨: 불린! (사전 정의된 또는 사용자 정의 역할입니까?)

계정 역할 쿼리 예시

query{
  계정 역할(accountID: XXX, accountType: REGULAR)
  {
    항목들
    {
      id
      이름
      사전 정의됨
      설명
    }
    총계
  }
}

updateAdminRoleInput 구성 API

updateAdminRoleInput 구성 API를 사용하면 Cato 관리 애플리케이션에 대한 관리자 역할의 설정을 업데이트할 수 있습니다.

입력 updateAdminRoleInput {
  역할: updateAccountRoleInput!
  허용된 엔터티: [entityInput!]
}

Documentation Index