API 레퍼런스: 조직

조직은 여러 테넌트를 하나의 단위로 묶습니다.

테넌트가 속한 조직 조회

테넌트 범위 API 키로 조회할 수 있으며, 조직 범위 키도 사용할 수 있습니다.

엔드포인트: GET /v1/tenant/{tenantId}/organization

인증: 테넌트 또는 조직 범위 API 키 · read scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid

응답(200):

조직 정보

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

필드	유형	필수	설명
id	string	예	형식: uuid
displayName	string	예	기본값: "" 최대 길이: 128
createdAt	string	예	형식: date-time
contactEmail	string	예	형식: email
isActive	boolean	예	기본값: true
allowedLogins	object	예
createdBy	string	예	형식: uuid

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 404 리소스를 찾을 수 없음

조직의 라이선스 수용량 및 자동 동기화 정책 조회

조직 전체의 단계별 구매 라이선스와 사용 중 라이선스(Process Foundation, Process Architecture, Process Intelligence), 무료 Viewer 허용 수, 자동 동기화 목표, 라이선스 변동 설명(시스템이 수행할 작업과 시점), 결제 주기, externalApiSeatPolicy를 반환합니다. 테넌트 범위 API 키로 조회할 수 있습니다. 경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: GET /v1/tenant/{tenantId}/organization/billing/seats

인증: 테넌트 또는 조직 범위 API 키 · read scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid

응답(200):

라이선스 수용량

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

필드	유형	필수	설명
contractType	free | selfServe | fixed | unlimited	예	허용 값: free, selfServe, fixed, unlimited
isTrial	boolean	예
purchased	object	예
inUseBillable	object	예
inUseFree	number	예
inUseDashboardViewers	number	예
totalBillable	number	예
freeViewerAllowance	number	예
freeViewerOverAllowance	number	예
dashboardViewerAllowance	number	예
dashboardViewerOverAllowance	number	예
fixedOverage	number	예
target	object	예
drift	object[]	예
interval	month | year	예	허용 값: month, year
nextBilledAt	string	예
externalApiSeatPolicy	autoBill | requireCapacity	예	허용 값: autoBill, requireCapacity

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 404 리소스를 찾을 수 없음

조직 전체 통계 조회

경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: GET /v1/tenant/{tenantId}/organization/statistics

인증: 조직 범위 API 키 · read scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid

응답(200):

조직 통계

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}

필드	유형	필수	설명
userCount	number	예
tenantCount	number	예
tenantStatistics	object[]	예

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨

조직의 모든 테넌트 목록 조회

경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: GET /v1/tenant/{tenantId}/organization/tenants

인증: 조직 범위 API 키 · read scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid
limit	integer	쿼리	아니요	반환할 최대 항목 수
offset	integer	쿼리	아니요	건너뛸 항목 수

응답(200):

테넌트 목록

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨

조직에 새 테넌트 생성(조직 범위 API 키 필요)

경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: POST /v1/tenant/{tenantId}/organization/tenants

인증: 조직 범위 API 키 · write scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid

요청 본문:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

필드	유형	필수	설명
displayName	string	아니요	최대 길이: 128
shortName	string	예
description	string	아니요	최대 길이: 200
timezone	string	아니요	최대 길이: 64
tenantType	normal | sandbox | demo	아니요	허용 값: normal, sandbox, demo

응답(201):

테넌트 생성됨

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

필드	유형	필수	설명
id	string	예	형식: uuid
createdBy	string	예	형식: uuid
createdAt	string	예	형식: date-time
displayName	string	예	기본값: "" 최대 길이: 128
contactEmail	string	예	형식: email
isActive	boolean	예	기본값: true
shortName	string	예
useOrganizationTheme	boolean	예	기본값: true
description	string	예	최대 길이: 200
organizationId	string	예	형식: uuid
allowedLogins	object	예
tenantType	normal | sandbox | demo	예	허용 값: normal, sandbox, demo 기본값: normal
url	string	예	형식: uri

오류:

• 400 잘못된 요청: 유효하지 않은 필터 표현식, 모델이 없는 프로세스, 지원되지 않는 업로드 형식 또는 필수 필드 누락 등
• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 403 API 키에 필요한 scope 또는 조직 액세스 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않음
• 406 값을 허용할 수 없음(예: 예약되었거나 중복된 short name)

조직의 테넌트 소프트 삭제(조직 범위 API 키 필요)

테넌트의 API 액세스는 즉시 중단됩니다. 삭제 안전 기간에는 테넌트와 데이터가 보존되며, 이후 자동 완전 삭제 절차를 통해 제거됩니다. 현재 사용 중인 테넌트(컨텍스트 테넌트)는 삭제할 수 없습니다.

엔드포인트: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

인증: 조직 범위 API 키 · write scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid
targetId	string	경로	예	형식: uuid

응답(200):

테넌트 삭제됨

{
	"success": true,
	"message": "string"
}

필드	유형	필수	설명
success	boolean	예
message	string	예

오류:

• 400 잘못된 요청: 유효하지 않은 필터 표현식, 모델이 없는 프로세스, 지원되지 않는 업로드 형식 또는 필수 필드 누락 등
• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 403 API 키에 필요한 scope 또는 조직 액세스 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않음
• 404 리소스를 찾을 수 없음

조직에서 소프트 삭제된 테넌트 복원(조직 범위 API 키 필요)

삭제 안전 기간 내에 소프트 삭제를 취소하면 테넌트와 데이터가 삭제 전 상태 그대로 복원되고 API 액세스가 다시 시작됩니다. 경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

인증: 조직 범위 API 키 · write scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid
targetId	string	경로	예	형식: uuid

응답(200):

테넌트 복원됨

{
	"success": true,
	"message": "string"
}

필드	유형	필수	설명
success	boolean	예
message	string	예

오류:

• 400 잘못된 요청: 유효하지 않은 필터 표현식, 모델이 없는 프로세스, 지원되지 않는 업로드 형식 또는 필수 필드 누락 등
• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 403 API 키에 필요한 scope 또는 조직 액세스 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않음
• 404 리소스를 찾을 수 없음

조직의 모든 사용자 목록 조회

경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: GET /v1/tenant/{tenantId}/organization/users

인증: 조직 범위 API 키 · read scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid
limit	integer	쿼리	아니요	반환할 최대 항목 수
offset	integer	쿼리	아니요	건너뛸 항목 수

응답(200):

조직 사용자 목록

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨

조직 사용자 설정 변경(조직 범위 API 키 필요)

본문의 역할 플래그(isAdminInOrganization, isActiveInOrganization)는 입력된 값 그대로 적용됩니다. 조직 관리자에게만 조직 범위 키를 발급하세요. 경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: PUT /v1/tenant/{tenantId}/organization/users/{userId}

인증: 조직 범위 API 키 · write scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid
userId	string	경로	예	형식: uuid

요청 본문:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

필드	유형	필수	설명
isActiveInOrganization	boolean	아니요	조직에서 사용자가 활성 상태인지 여부
isAdminInOrganization	boolean	아니요	조직 관리자 권한(입력된 값 그대로 적용됨: 조직 관리자에게만 조직 범위 키를 발급하세요)

응답(200):

변경됨

{
	"message": "string"
}

필드	유형	필수	설명
message	string	예

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 403 API 키에 필요한 scope 또는 조직 액세스 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않음
• 404 리소스를 찾을 수 없음

조직에서 사용자 제거(조직 범위 API 키 필요)

경로 매개변수 {tenantId}는 작업 대상이 아니라 컨텍스트 테넌트(조직 범위 키가 속한 조직)를 나타냅니다.

엔드포인트: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

인증: 조직 범위 API 키 · write scope

매개변수:

이름	유형	위치	필수	설명
tenantId	string	경로	예	형식: uuid
userId	string	경로	예	형식: uuid

응답(200):

사용자 제거됨

{
	"message": "string"
}

필드	유형	필수	설명
message	string	예

오류:

• 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
• 403 API 키에 필요한 scope 또는 조직 액세스 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않음
• 404 리소스를 찾을 수 없음