Canva 관리자 API 설정 및 사용
참고: 관리자 API를 사용하려면 Canva 구독 조직이 있어야 합니다. 관리자 API는 조직 수준에서 작동합니다.
Canva 관리자 API를 사용하면 자체 시스템에서 조직 관리를 자동화할 수 있습니다. Canva에서 직접 작업을 일일이 처리하지 않고도 사용자, 팀, 그룹, 멤버십을 관리하고 감사 로그 이벤트를 가져올 수 있습니다.
사용 가능 여부 확인
- Canva Enterprise, Canva Districts, 대학용 Canva에서 사용할 수 있습니다.
- 조직 관리자만 사용할 수 있습니다.
- 단일 팀 및 여러 팀으로 구성된 조직에서 사용할 수 있습니다.
요구 사항 확인
관리자 API를 설정하기 전에 조직이 다음 요구 사항을 충족하는지 확인하세요:
- 조직 수준: 관리자 API는 조직 단위로 적용됩니다. Canva Enterprise, Canva Districts, 대학용 Canva 요금제를 사용하는 단일 팀 및 여러 팀으로 구성된 조직에서 사용할 수 있습니다.
- 조직 관리자 계정: 조직 관리자만 Canva 설정에서 관리자 API 클라이언트를 만들고 관리할 수 있습니다.
- 사내 또는 외주 엔지니어링 인력: 조직에서 통합 기능을 개발하고 유지 관리하려면 엔지니어링 리소스가 필요합니다. Canva는 구현을 지원하지 않습니다.
- 팀에서 API를 사용해 개발할 수 없다면, 조직의 사용자 관리를 자동화하는 데는 SCIM 프로비저닝이 더 적합합니다.
- Canva 구조에 대한 이해: 통합 기능을 개발하기 전에 Canva에서 조직, 팀, 그룹이 어떻게 구성되어 있는지 명확히 파악하세요.
- 다단계 인증(MFA) 또는 통합 인증(SSO) 관리 계정: 관리자 API를 설정하는 조직 관리자는 MFA를 사용하도록 설정했거나 SSO로 관리되는 계정을 보유해야 합니다. 해당 계정은 관리자를 대신해 작업을 수행하는 조직에서 관리하거나 소유해야 합니다.
관리할 수 있는 항목 알아보기
관리자 API는 다음 작업을 위한 엔드포인트를 제공합니다.
- 사용자, 팀, 그룹: 만들기, 조회, 업데이트, 삭제
- 멤버십: 팀과 그룹에 팀원을 추가하거나 제거하고 역할 설정
- 감사 로그: 감사 로그 이벤트를 예약하여 가져오기
- 팀 초대: 팀에 팀원 초대(조직 외부의 팀원 포함), 대기 중인 초대 보기, 정확한 이메일 주소로 기존 초대 링크 가져오기, 초대 취소
관리자 API 설정하기
조직 관리자가 관리자 API 클라이언트를 만들고 이를 사용해 API를 호출합니다.
관리자 API 설정
- 설정으로 이동합니다.
- 관리자 API를 선택한 다음, API 클라이언트 생성을 선택합니다.
- 클라이언트의 이름을 지정하고 클라이언트가 액세스할 수 있는 범위를 선택합니다.
- 계속을 선택합니다.
- 클라이언트 ID와 클라이언트 시크릿을 복사한 다음, 완료를 선택합니다.
- 자격 증명을 4시간 동안 유효한 액세스 토큰으로 교환합니다.
- 액세스 토큰을 사용하여 관리자 API를 호출합니다.
Canva 관리자 API 문서를 따라 클라이언트 인증 정보를 액세스 토큰으로 교환하고 API 요청을 시작하세요.
API 요청 인증 및 OAuth 2.0 Bearer 토큰 사용에 관한 기술 세부 정보는 엔지니어링 팀과 Canva 관리자 API 인증 문서를 공유하세요.
관리자 API 감사 로그 알아보기
관리자 API를 통해 수행된 작업은 해당 API를 호출한 개별 관리자 대신 관리자 API 클라이언트에 기록됩니다.
감사 로그의 Actor 필드에는 관리자 API 클라이언트 이름과 클라이언트 ID가 표시됩니다. 이를 통해 어떤 통합 기능이 작업을 수행했는지 확인할 수 있습니다.
특정 API 클라이언트를 만들거나 업데이트하거나 삭제한 조직 관리자도 확인할 수 있습니다.
자세한 내용은 Canva 감사 로그 정보를 참조하세요.
팀에 팀원 초대하기
조직 관리자는 관리자 API를 사용해 조직 외부의 협업자를 포함하여 팀에 팀원을 초대할 수 있습니다.
알아두어야 할 사항
- 각 초대는 하나의 팀과 하나의 이메일 주소에 대해 생성됩니다.
- 각 초대는 한 번만 사용할 수 있으며, 30일 후 만료됩니다.
- 설정에 따라 Canva에서 초대 대상자에게 초대 이메일을 자동으로 보내지 않을 수 있습니다. 필요한 경우 초대 링크를 직접 공유하세요.
- 초대 링크를 비공개로 유지하세요. 초대 링크는 링크를 생성할 때 지정한 이메일 주소로만 사용할 수 있습니다.
- 초대 대상자에게는 기존 팀 초대 및 도메인 설정이 계속 적용됩니다.
- 초대 대상자에 대해 대기 중인 초대가 이미 있는 경우, 새 초대를 만들면 동일한 초대 기록이 반환됩니다. 만료일은 요청일로부터 30일 후로 재설정되고 초대 대상자의 역할은 요청한 역할로 업데이트됩니다.
엔드포인트에 관한 자세한 내용은 Canva 관리자 API 문서를 참조하세요.
관리자 API와 SCIM 중 선택하기
관리자 API와 SCIM 모두 사용자 프로비저닝을 지원합니다.
관리자 API는 사용자 프로비저닝 외에도 Canva 조직 관리를 지원합니다. 여기에는 팀, 그룹, 멤버십, 감사 로그가 포함됩니다.
SCIM은 표준 프로비저닝 및 프로비저닝 해제를 지원합니다. 표준 사용자 프로비저닝만 필요하거나 팀에서 맞춤 API 통합 기능을 개발할 수 없다면 SCIM이 더 적합합니다.
자주 묻는 질문
관리자 API를 사용하려면 조직에 개발자가 필요한가요?
네. 관리자 API를 사용하려면 조직에서 통합 기능을 개발하고 유지 관리할 사내 또는 외주 엔지니어링 인력이 필요합니다. Canva는 구현을 지원하지 않습니다. 팀에서 API를 사용해 개발할 수 없다면 조직의 사용자 관리를 자동화하는 데는 SCIM 프로비저닝이 더 적합합니다.
관리자 API를 사용하려면 조직의 모든 구성원이 MFA 또는 통합 인증(SSO)을 사용해야 하나요?
아니요. 관리자 API를 설정하는 조직 관리자만 MFA를 사용하도록 설정했거나 SSO로 관리되는 계정을 보유해야 합니다. 해당 계정은 관리자를 대신해 작업을 수행하는 조직에서 관리하거나 소유해야 합니다. 관리자 API를 사용하기 위해 조직의 다른 구성원이 MFA 또는 통합 인증(SSO)을 사용해야 하는 것은 아닙니다.
관리자 API를 사용해 조직 외부의 협업자를 초대할 수 있나요?
네. 조직 관리자는 관리자 API를 사용해 외부 협업자를 포함하여 팀에 팀원을 초대할 수 있습니다. 초대 대상자에게는 기존 팀 초대 및 도메인 설정이 계속 적용됩니다.
새 초대를 만들지 않고 기존 초대 링크를 다시 가져올 수 있나요?
네. 새 초대를 만들지 않고 초대 대상자의 정확한 이메일 주소를 사용해 기존 초대 링크를 가져올 수 있습니다.
도움이 되셨나요?
도움이 되었어요
도움이 되지 않았어요