Motimate: 공개 API를 사용하여 사용자 및 그룹을 프로비저닝하고 관리하는 방법은 무엇인가요?

소스 시스템을 REST API에 연결하여 모티메이트에서 사용자를 프로비저닝하고 관리할 수 있습니다. 이를 통해 사용자 생성, 사용자 업데이트, 사용자 삭제, 그룹 생성 및 올바른 그룹에 사용자 프로비저닝과 같은 여러 핵심 작업을 Motimate에서 처리할 수 있습니다. 

배경 정보: 

• 모든 사용자와 그룹에는 API와 함께 사용할 수 있는 고유한 모티메이트 ID가 있지만, API와 함께 사용할 수 있는 '외부 ID'를 정의할 수도 있습니다. 이 '외부 ID'는 일반적으로 자체 데이터 소스에서 해당 사용자 또는 그룹에 대해 가지고 있는 ID와 일치하도록 설정됩니다. 
   
• 그룹은 계층 구조 또는 그룹 트리를 만드는 데 사용됩니다. 이는 일반적으로 조직 구조와 밀접하게 반영되며 교육을 위임하고 보고서를 받는 데 사용됩니다. 이는 부서와 팀 또는 지역을 기반으로 하는 경우가 많습니다. 사용자를 만들 때 그룹에 바로 사용자를 할당할 수 있도록 사용자를 만들기 전에 그룹을 만드는 것이 좋습니다. 그룹 구조에 대한 자세한 내용은 여기를 참조하세요.
   
• 사용자 직급을 사용하면 조직에서 사용자의 역할에 따라 교육을 위임할 수 있습니다. 사용자 포지션에 대한 자세한 내용은 여기를 참조하세요.
   
• 프로덕션 환경으로 이전하기 전에 테스트 환경을 설정하여 통화 및 통합을 전반적으로 테스트하는 것이 좋습니다. 고객 성공 관리자 또는 support@motimateapp.com 에 문의하여 도움을 받으세요. 
   
• 모티메이트의 API는 JSON 형식입니다. 

그룹 만들기

그룹을 만들려면 다음 호출을 이용하세요:
POST https://motimateapp.com/public_api/groups

그룹과 함께 필요한 정보와 함께 페이로드를 본문에 추가합니다. 'parent_id' 필드는 그룹 구조를 만드는 데 사용됩니다. 이 필드에 다른 그룹의 ID를 입력하면 해당 그룹이 부모 그룹으로 설정됩니다.

참고: 그룹의 레벨은 상위 그룹보다 하위 계층 구조에 있어야 하며, '레벨 1'이 가장 높은 레벨입니다. 이를 통해 그룹 구조를 모티메이트 계정으로 가져올 수 있습니다. 

그룹 업데이트 

모티메이트에서 그룹을 업데이트하려면 다음 호출이 필요합니다. 이 예제에서 사용된 아이디는 모티메이트 그룹 아이디입니다. 

PATCH https://motimateapp.com/public_api/groups/{group_id}

그룹에서 업데이트하려는 필수 데이터가 포함된 페이로드를 본문에 추가합니다. 그룹을 다른 레벨로 이동하거나 구조를 조정해야 할 때 이 기능을 사용할 수 있습니다. 

 

그룹 삭제하기

모티메이트에서 그룹을 삭제하려면 다음 호출이 필요합니다. 이 예제에서 사용된 아이디는 모티메이트 그룹 아이디입니다. 강제로 ´1´로 설정하면 레코드가 하드 파기되며, 이 시나리오에서는 그룹을 복구할 방법이 없습니다.

삭제 https://motimateapp.com/public_api/groups/{group_id}

이 호출을 실행하면 선택한 그룹이 삭제되지만 응답은 반환되지 않습니다:

 

사용자 만들기

사용자를 만들려면 다음 호출을 사용합니다: 

POST https://motimateapp.com/public_api/users

사용자의 필요한 정보와 함께 페이로드를 본문에 추가합니다. 이메일 주소 또는 전화번호는 모티메이트 계정 설정에 따라 필수 입력 항목으로 지정됩니다. 그룹 할당 필드를 사용하여 사용자의 그룹을 선택할 수 있습니다. 사용자가 속하게 할 그룹 ID와 그룹에서의 역할(멤버, 관리자 또는 참관인)을 입력합니다. 대부분의 시나리오에서 assing_ancestors를 'true'로 설정하는 것이 좋습니다. 이렇게 하면 사용자는 할당된 그룹의 상위 그룹의 멤버가 됩니다. 

 

사용자 업데이트

모티메이트에서 사용자 정보를 업데이트하려면 다음 호출이 필요합니다. 이 예제에서 사용된 아이디는 모티메이트 사용자 아이디입니다. 

PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

사용자에게 업데이트하려는 필요한 데이터만 본문에 페이로드를 추가합니다.

 

사용자 삭제

모티메이트에서 사용자를 삭제하려면 다음 호출이 필요합니다. 이 예제에서 사용된 아이디는 모티메이트 사용자 아이디입니다. 강제로 ´1´로 설정하면 레코드가 하드 파기되며, 이 시나리오에서는 그룹을 복구할 방법이 없습니다. '0'으로 설정하면 레코드가 소프트 삭제되어 필요한 경우 복구할 수 있습니다. 

삭제 https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

이 호출을 실행하면 응답이 반환되지는 않지만 선택한 사용자가 삭제됩니다: 

사용자 복원

실수로 사용자가 삭제되어 복구해야 하는 경우가 있습니다. 하드 삭제가 아닌 소프트 삭제된 경우에는 다음 호출을 통해 삭제할 수 있습니다. 이 예제에서 사용된 아이디는 모티메이트 사용자 아이디입니다. 

PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id