새 사용자 생성
POST /accounts/{account_id}/core/v1/users
생성할 사용자 API 리소스에 대해 원하는 값을 나타냅니다.
매개변수
| 이름 | 유형 | 에서 | 필수 요소입니다 | 설명 |
|---|---|---|---|---|
account_id |
문자열 |
경로 |
참 |
포함하는 계정 리소스의 ID
|
요청 본문
생성할 사용자 API 리소스에 대해 원하는 값을 나타냅니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
리소스의 미디어 유형입니다. 정의된 값은 다음과 같습니다.
|
버전 |
문자열 |
참 |
리소스 버전입니다. 정의된 값은 다음과 같습니다.
|
authID |
문자열 |
거짓 |
외부 ID 공급자와 연결된 식별자를 포함하는 JSON 문자열입니다. 이 문자열의 내용은 지정된 authProvider에 따라 다릅니다. "authProvider"가 "local"인 사용자의 경우 "authID"는 "email" 값으로 설정됩니다. "authProvider"가 "ldap"인 사용자의 경우 "authID"는 LDAP 서버의 고유 이름(DN)으로 설정됩니다. |
authProvider |
문자열 |
거짓 |
idAuth 식별자의 컨텍스트를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
firstName |
문자열 |
거짓 |
사용자가 지정한 긴 형식의 이름을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
lastName |
문자열 |
거짓 |
사용자가 지정한 긴 형식의 성을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
companyName |
문자열 |
거짓 |
사용자와 연결된 회사 이름을 포함하는 JSON 문자열입니다. 이 키가 존재하지 않으면 회사 이름이 제공되지 않았음을 나타냅니다. 정의된 값은 다음과 같습니다.
|
이메일 |
문자열 |
참 |
사용자가 지정한 이메일 주소가 포함된 JSON 문자열입니다. |
전화 |
문자열 |
거짓 |
사용자의 전화번호가 포함된 JSON 문자열입니다. 이 키가 존재하지 않으면 전화번호가 제공되지 않았음을 나타냅니다. |
postalAddress |
거짓 |
주소를 지정하는 필드 모음을 포함하는 JSON 객체입니다. 이 키가 존재하지 않으면 주소가 제공되지 않았음을 나타냅니다. 이 키가 존재하면 포함된 6개의 필드가 모두 표시됩니다. 사용자가 아무것도 제공하지 않으면 문자열은 비어 있습니다. |
|
sendWelcomeEmail |
문자열 |
거짓 |
유효성 검사 후 환영 이메일을 보낼지 여부를 나타내는 JSON 문자열입니다. 생성 시 지정하지 않으면 ACS의 경우 "true", Astra Control Center의 경우 "false"로 설정됩니다. 정의된 값은 다음과 같습니다.
|
메타데이터 |
거짓 |
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
|
요청 예시
{
"type": "application/astra-user",
"version": "1.2",
"firstName": "John",
"lastName": "Doe",
"email": "jdoe@example.com"
}
응답
Status: 201, Returns the newly created user resource in the JSON response body.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
리소스의 미디어 유형입니다. 정의된 값은 다음과 같습니다.
|
버전 |
문자열 |
참 |
리소스 버전입니다. 정의된 값은 다음과 같습니다.
|
ID입니다 |
문자열 |
참 |
리소스의 전역 고유 식별자입니다. 정의된 값은 다음과 같습니다.
|
상태 |
문자열 |
참 |
사용자의 작동 상태를 나타내는 값을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
isEnabled |
문자열 |
참 |
사용자의 로그인 허용 여부를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
authID |
문자열 |
거짓 |
외부 ID 공급자와 연결된 식별자를 포함하는 JSON 문자열입니다. 이 문자열의 내용은 지정된 authProvider에 따라 다릅니다. "authProvider"가 "local"인 사용자의 경우 "authID"는 "email" 값으로 설정됩니다. "authProvider"가 "ldap"인 사용자의 경우 "authID"는 LDAP 서버의 고유 이름(DN)으로 설정됩니다. |
authProvider |
문자열 |
거짓 |
idAuth 식별자의 컨텍스트를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
firstName |
문자열 |
참 |
사용자가 지정한 긴 형식의 이름을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
lastName |
문자열 |
참 |
사용자가 지정한 긴 형식의 성을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
companyName |
문자열 |
거짓 |
사용자와 연결된 회사 이름을 포함하는 JSON 문자열입니다. 이 키가 존재하지 않으면 회사 이름이 제공되지 않았음을 나타냅니다. 정의된 값은 다음과 같습니다.
|
이메일 |
문자열 |
참 |
사용자가 지정한 이메일 주소가 포함된 JSON 문자열입니다. |
전화 |
문자열 |
거짓 |
사용자의 전화번호가 포함된 JSON 문자열입니다. 이 키가 존재하지 않으면 전화번호가 제공되지 않았음을 나타냅니다. |
postalAddress |
거짓 |
주소를 지정하는 필드 모음을 포함하는 JSON 객체입니다. 이 키가 존재하지 않으면 주소가 제공되지 않았음을 나타냅니다. 이 키가 존재하면 포함된 6개의 필드가 모두 표시됩니다. 사용자가 아무것도 제공하지 않으면 문자열은 비어 있습니다. |
|
sendWelcomeEmail |
문자열 |
참 |
유효성 검사 후 환영 이메일을 보낼지 여부를 나타내는 JSON 문자열입니다. 생성 시 지정하지 않으면 ACS의 경우 "true", Astra Control Center의 경우 "false"로 설정됩니다. 정의된 값은 다음과 같습니다.
|
enableTimestamp |
문자열 |
거짓 |
사용자가 마지막으로 활성화된 시간을 나타내는 ISO-8601 형식의 타임스탬프가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
lastActTimestamp |
문자열 |
거짓 |
이 사용자를 대신하여 ID API가 마지막으로 호출된 시간을 나타내는 ISO-8601 형식의 타임스탬프가 포함된 JSON 문자열입니다. (참고: 이 작업은 비용이 많이 듭니다.) 정의된 값은 다음과 같습니다.
|
메타데이터 |
참 |
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
|
응답 예
{
"type": "application/astra-user",
"version": "1.2",
"id": "5bad8e04-e2fd-5c43-98d7-300580993f49",
"state": "pending",
"isEnabled": "true",
"authID": "HteLK3hk28sdbDLKHReB",
"authProvider": "cloud-central",
"firstName": "John",
"lastName": "Doe",
"email": "jdoe@example.com",
"sendWelcomeEmail": "true",
"lastActTimestamp": "2020-08-05T14:24:54.128427Z",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
응답
Status: 401, Unauthorized
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
응답 예
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
응답
Status: 400, Bad request
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
|
invalidFields |
배열["invalidFields"] |
거짓 |
유효하지 않은 요청 본문 필드 목록 |
응답 예
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
응답
Status: 409, Conflict
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
|
invalidFields |
배열["invalidFields"] |
거짓 |
유효하지 않은 요청 본문 필드 목록 |
응답 예
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
응답
Status: 403, Forbidden
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
응답 예
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
오류
Status: 404, Not found
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
예시 오류 응답
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
정의
정의를 참조하세요
postalAddress
주소를 지정하는 필드 모음을 포함하는 JSON 객체입니다. 이 키가 존재하지 않으면 주소가 제공되지 않았음을 나타냅니다. 이 키가 존재하면 포함된 6개의 필드가 모두 표시됩니다. 사용자가 아무것도 제공하지 않으면 문자열은 비어 있습니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
addressCountry |
문자열 |
참 |
ISO 3166 Alpha-2에 명시된 대로 우편 주소와 관련된 국가명 또는 국가 코드를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
addressLocality |
문자열 |
참 |
우편 주소와 관련된 지역(예: 도시) 정보를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
addressRegion |
문자열 |
참 |
우편 주소와 관련된 지역(예: 주)을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
postalCode |
문자열 |
참 |
우편 주소와 연결된 우편번호를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
streetAddress1 |
문자열 |
참 |
우편 주소와 연결된 도로명 주소를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
streetAddress2 |
문자열 |
거짓 |
선택적 부가 주소 정보(예: 우편 사서함)를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
type_astra_label
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
|
값 |
문자열 |
참 |
type_astra_메타데이터_업데이트
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
-
Astra 메타데이터 스키마를 준수합니다. 생성 시 지정하지 않으면 레이블이 없는 메타데이터 객체가 생성됩니다. 업데이트 시 지정하지 않으면 메타데이터 객체의 레이블인 creationTimestamp와 createdBy는 수정 없이 유지됩니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
라벨 |
거짓 |
||
CreationTimestamp 를 클릭합니다 |
문자열 |
거짓 |
|
modificationTimestamp |
문자열 |
거짓 |
|
생성 시 |
문자열 |
거짓 |
|
modifiedBy |
문자열 |
거짓 |
invalidParams
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
잘못된 쿼리 매개변수의 이름 |
이유 |
문자열 |
참 |
쿼리 매개변수가 유효하지 않은 이유 |
invalidFields
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
유효하지 않은 요청 본문 필드의 이름 |
이유 |
문자열 |
참 |
요청 본문 필드가 유효하지 않은 이유 |