API를 사용하여 조직에 사용자 프로비저닝

Snyk API를 사용하면 사용자가 처음 로그인하기 전에 조직으로 초대하고 권한을 부여할 수 있습니다. 이는 대규모 팀을 온보딩할 때 유용합니다.

API를 사용하여 사용자를 프로비저닝하기 위한 사전 준비 사항

시작하기 전에 다음이 필요합니다.

• 조직 ID (Org ID): 사용자를 추가하려는 Snyk 조직의 고유 ID입니다.

• API 토큰: '조직 관리자(Org Admin)' 권한이 있는 서비스 계정 또는 개인 API 토큰이 필요합니다.

• 사용자 이메일 주소: 프로비저닝하려는 사용자의 이메일 주소입니다.

사용자 프로비저닝 단계

사용자를 조직에 프로비저닝하려면 조직에 사용자 프로비저닝 엔드포인트를 사용합니다.

1. API 요청 보내기

curl을 사용하여 다음과 같이 요청을 보낼 수 있습니다.

curl --request POST \
  --url https://api.snyk.io/v1/org/{orgId}/provision \
  --header 'Authorization: token YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{ \
    "email": "[email protected]", \
    "role": "member" \
  }'

• {orgId}: 대상 조직의 ID로 바꿉니다.

• email: 사용자의 이메일 주소입니다.

• role: 사용자에게 부여할 역할입니다 (예: admin, collaborator, member).

2. 상태 확인

사용자가 성공적으로 프로비저닝되면 해당 사용자는 로그인 시 지정된 조직에 자동으로 추가됩니다. 대기 중인 사용자 프로비저닝 목록 보기 엔드포인트를 사용하여 처리되지 않은 프로비저닝 요청을 확인할 수 있습니다.

참고 사항

• 사용자가 이미 Snyk 계정을 가지고 있는 경우, 해당 조직에 즉시 추가됩니다.

• 계정이 없는 경우, 사용자가 SSO 또는 다른 인증 수단을 통해 처음 로그인할 때 프로비저닝 설정이 적용됩니다.

• 사용자 정의 역할(Custom Roles)을 사용하는 경우, 역할의 이름이 아닌 고유 ID를 사용해야 할 수도 있습니다.

자세한 내용은 Snyk API 참조 문서를 확인하십시오.