Go to main content

Oracle® ZFS Storage Appliance RESTful API 설명서, 릴리스 OS8.8.x

인쇄 보기 종료

업데이트 날짜: 2021년 8월
 
 

사용자 서비스 등록 정보

사용자 이름 및 암호와 함께 사용자 서비스 등록 정보는 특성(예: 사용자에게 부여된 권한, 사용자에게 적용되는 제한사항 및 사용자의 로케일)을 정의합니다.

사용자 등록 정보

사용자 등록 정보는 다음과 같을 수 있습니다. 일부 등록 정보는 특정 유형의 사용자에 대해서만 사용할 수 있습니다.

표 77  사용자 등록 정보
등록 정보
유형
설명
logname
string
고유 사용자 이름입니다. logname은 사용자가 만들어진 후 변경할 수 없습니다.
type
string
사용자 유형(local, directory, data, nologin)입니다. type은 사용자가 만들어진 후 변경할 수 없습니다. 기본값: local
uid
number
사용자 ID입니다. 사용자 ID를 지정하거나 시스템의 사용자 ID 지정을 허용할 수 있습니다. 사용자 ID를 지정하는 경우 사용자 ID는 100보다 작을 수 없으며, 2147483646보다 클 수 없고, 60001, 60002 또는 65534와 같을 수 없습니다. uid는 사용자가 만들어진 후 변경할 수 없습니다.
fullname
string
사용자의 전체 이름 또는 실제 이름입니다. BUI에서 전체 이름이 대시보드 상단의 Logout(로그아웃) 버튼 왼쪽에 표시되며 브라우저 탭에도 표시될 수 있습니다. 기본값: logname과 동일
initial_password
string
로컬 및 데이터 사용자에 대한 암호입니다.
require_annotation
boolean
true인 경우
  • BUI – 초기 BUI 페이지를 표시하기 전에 사용자에게 설명을 입력하도록 합니다.

  • CLI – CLI 프롬프트를 표시하기 전에 사용자에게 설명을 입력하도록 합니다.

  • REST – 요청이 권한 부여되지 않은 상태로 실패합니다.

세션 주석은 감사 로그에 나타납니다.
roles
list
디렉토리 또는 로컬 사용자에게 지정된 역할입니다.
kiosk_mode
boolean
true인 경우 이 사용자는 키오스크 사용자입니다.
  • BUI – 사용자가 kiosk_screen 등록 정보 값인 화면만 볼 수 있도록 제한됩니다.

  • CLI – 로그인을 실패합니다.

  • REST – 요청이 권한 부여되지 않은 상태로 실패합니다.

kiosk_screen
string
kiosk_mode가 true인 경우 이 사용자가 제한되는 BUI 화면입니다. 기본값: status/dashboard
exceptions
list
디렉토리 사용자나 로컬 사용자에게 지정된 추가 권한 부여 또는 역할에서 지정된 권한 부여에 대한 제한사항입니다.
preferences
list
사용자 환경 설정(예: 로케일, BUI 시작 페이지, 시간 초과, SSH 공개 키 및 REST 로그인 토큰)입니다.

해당 등록 정보에 대한 추가 설명은 다음 설명서를 참조하십시오.

사용자 역할 및 예외사항

roles 등록 정보를 사용하여 사용자에게 기존 역할을 지정할 수 있습니다. 역할을 만들려면 RESTful API 역할 서비스를 참조하십시오.

exceptions 등록 정보를 통해 사용자에 대한 권한 부여를 추가할 수 있습니다. 이 방식으로 권한 부여를 제거할 수도 있습니다. 예를 들어, 특정 권한을 부여하는 역할이 사용자에게 지정된 경우 예외사항 목록에서 개별 권한 부여를 false로 설정할 수 있습니다. 이때 해당 역할에 포함된 다른 권한 부여는 유지됩니다.

다음 요청은 사용자 user1에 대한 Kerberos 서비스를 다시 시작할 수 있는 권한 부여를 추가합니다.

POST /api/user/v1/users/user1/exceptions HTTP/1.1

{
    "scope": "svc",
    "service": "kerberos",
    "allow_restart": true
}

다음 결과는 user1에 대한 Kerberos 서비스에 사용 가능한 모든 권한 부여를 보여줍니다. 이 예에서 기타 권한 부여의 기본값은 false입니다.

{
    "auth": {
        "href": "/api/user/v1/users/user1/exceptions/auth-001",
        "scope": "svc",
        "service": "kerberos",
        "allow_administer": false,
        "allow_configure": false,
        "allow_restart": true
    }
}

사용자 환경 설정 등록 정보

로그인한 사용자 또는 allow_changePreferences 권한이 부여된 사용자에 대한 환경 설정을 지정할 수 있습니다. allow_changePreferences 권한 부여를 얻으려면 사용자 역할 및 예외사항을 참조하십시오.

표 78  사용자 환경 설정 등록 정보
등록 정보
유형
설명
locale
string
지역성입니다. 기본값: C
login_screen
string
페이지가 URL에서 지정되지 않은 경우 로그인을 성공할 때 표시되는 BUI 페이지입니다. 기본값: status/dashboard
session_timeout
integer
사용자가 BUI에서 벗어난 후 브라우저에서 자동으로 세션이 로그아웃될 때까지의 시간(분)입니다. 기본값: 15
cli_idle_timeout
integer
세션이 종료되기 전 CLI가 유휴 상태일 수 있는 기간(초)입니다. 기본값인 -1은 유휴 상태에서 CLI가 자동으로 닫히지 않음을 의미합니다.
advanced_analytics
string
고급 Analytics 통계 사용
keys
list
RSA/DSA 공개 키입니다
tokens
list
REST 로그인 토큰

해당 등록 정보에 대한 자세한 내용은 다음 절을 참조하십시오.

CLI 시간 초과

기본적으로 CLI가 유휴 상태일 수 있는 기간에는 제한이 없습니다(cli_idle_timeout 값이 -1임). CLI가 유휴 상태일 수 있는 기간에 대한 제한을 설정하려면 cli_idle_timeout초에 대해 양의 정수 값을 설정합니다. 시간 초과 제한에 도달하면 CLI가 닫힙니다.

다음 예에서는 CLI 시간 초과를 1시간으로 설정합니다.

PUT /api/user/v1/users/user1/preferences HTTP/1.1

{ "cli_idle_timeout": 3600 }
{
    "preferences": {
        "href": "/api/user/v1/users/user1/preferences",
        "locale": "C",
        "login_screen": "configuration/preferences",
        "session_timeout": 15,
        "cli_idle_timeout": 3600,
        "advanced_analytics": false,
        "keys": [],
        "tokens": []
    }
}

시간 초과를 사용 안함으로 설정하려면 cli_idle_timeout의 값을 -1로 설정하거나 다음 예에서와 같이 unset를 사용합니다.

PUT /api/user/v1/users/user1/preferences HTTP/1.1

{ "<unset>": ["cli_idle_timeout"] }

unset를 꺾쇠 괄호로 묶으면 unset라는 등록 정보가 있어도 문제가 발생하지 않습니다.

SSH 키

SSH 공개 키를 사용하면 암호를 사용하지 않고 SSH 연결을 허용할 수 있습니다.

표 79  SSH 키 등록 정보
등록 정보
유형
설명
type
string
SSH 키 유형: RSA 또는 DSA
key
string
SSH 키 내용
comment
string
이 SSH 키와 연관된 설명

REST 로그인 토큰

지속적 또는 비지속적 REST 로그인 토큰을 만들고 반환된 토큰 값 또는 토큰 ID를 통해 토큰에 액세스할 수 있습니다.

표 80  REST 로그인 토큰 등록 정보
등록 정보
유형
설명
name
string
토큰 이름입니다.
token_username
string
이 로그인 토큰을 사용할 수 있는 사용자의 이름입니다. 이 값은 요청 경로에서 설정됩니다.
preserve
boolean
false인 경우 기본 expiration 값을 사용합니다. true인 경우 사용자정의 expiration 값을 설정합니다. 기본값: false
expiration
number
토큰을 만드는 경우 이 값은 토큰이 만료될 때까지의 시간(초)입니다. preservetrue로 설정된 경우 이 등록 정보를 설정해야 합니다. preservefalse로 설정된 경우 expiration의 값은 900입니다.
토큰 등록 정보를 나열하는 경우 이 값은 해당 토큰이 만료될 날짜 및 시간입니다.

REST 로그인 토큰 질의 매개변수

GET 명령에서 token=token 질의 매개변수를 사용하여 해당 토큰에 대한 등록 정보 값을 표시할 수 있습니다. DELETE 명령에서 token=token 질의 매개변수를 사용하여 해당 토큰을 제거할 수 있습니다. token은 토큰 만들기 응답에서 X-Auth-Session의 값입니다.

token은 토큰이 만들어질 때 표시된 후 다시 표시되지 않습니다. token을 복사하여 보관해야 합니다. 예 3, REST 로그인 토큰 만들기를 참조하십시오.