사용자
사용자 자원은 API에서 검색된 데이터의 최종 사용자를 나타냅니다. 예를 들어, 앱이 API를 사용하여 사람들이 iCloud Photo Library 사진에 액세스 할 수있게하는 경우 최종 사용자는 해당 앱의 사용자입니다.
최고 수준의 데이터 보안을 허용하고 최고의 사용자 경험을 보장하기 위해 일관되게 최종 사용자를 식별하는 것이 중요합니다.
속성
이름 | 유형 | 기술 |
---|---|---|
id | 사용자 ID | 자원 식별자. |
resource | 문자열, 항상 user | 자원 유형 지정자. |
organisation | 조직 ID | 리소스가 속한 조직입니다. |
key | 키 ID | 리소스가 연관된 키입니다. |
identifier | 끈 | 사용자를 식별하고 중복을 방지하는 데 도움이되는 사용자 지정 값입니다. 예를 들어, 이것은 최종 사용자의 전자 메일 주소로 설정 될 수 있습니다. |
state | 끈 | 다음 중 하나 : active , deactivated , blocked . |
date_created | 날짜 시간 | 리소스가 생성 된 시점. |
식별자
identifier
속성은 API에서 사용되지 않지만 API에 저장된 정보와 구현 사이의 다리 역할을해야합니다. 이 속성의 값은 시스템 사용자와 API 사용자 간의 연결을 허용해야합니다. 시스템 내의 사용자 ID 또는 최종 사용자의 전자 메일 주소 일 수 있습니다.
주
-
active
- 사용자의 표준 상태
-
deactivated
- 소유하는 조직이이 사용자의 액세스를 사용 중지했습니다.
-
blocked
- API 관리자가이 사용자의 액세스를 사용 중지했습니다.
POST /users
만들기
매개 변수
이름 | 유형 | 기술 |
---|---|---|
organisation | 감독자 | API 관리자가 다른 조직을 대신하여 사용자를 만들 수 있습니다. |
key | 기본값 : 현재 키 | 사용자를 별도의 키에 할당하십시오. 예를 들어, 사용 권한이 적은 것일 수 있습니다. |
identifier | 필수, 문자열 | 시스템의 최종 사용자에 대해이 사용자를 식별하는 정보. |
cURL 사용
curl https://ricloud-api.reincubate.com/users \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "identifier": "end-user@email.com" }'
ricloud-py 사용하기
import ricloud user = ricloud.User.create(identifier='end-user@email.com')
GET /users/{user ID}
cURL 사용
curl https://ricloud-api.reincubate.com/users/<user ID> \ -H 'Authorization: Token <your key_token>'
ricloud-py 사용하기
import ricloud user = ricloud.User.retrieve(<user ID>)
GET /users
나열
매개 변수
이름 | 유형 | 기술 |
---|---|---|
key | 키 ID | 사용자가 연관된 키로 필터링합니다. |
identifier | 끈 | 사용자를 식별자로 필터링합니다. |
state | 끈 | 사용자를 해당 상태로 필터링합니다. |
date_created | 날짜 시간 필터 | 자원 생성 날짜별로 필터링하십시오. |
cURL 사용
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
ricloud-py 사용하기
import ricloud users = ricloud.User.list()
POST /users/{user ID}
업데이트
매개 변수
이름 | 유형 | 기술 |
---|---|---|
key | 키 ID | 다른 키와 연결되도록 사용자를 이동하십시오. 예를 들어, 재판에서 업데이트하는 경우. |
identifier | 끈 | 사용자 식별자를 업데이트하십시오. |
state | 끈 | 사용자 상태를 deactivated 또는 다시 active 상태로 업데이트하십시오. |
cURL 사용
curl https://ricloud-api.reincubate.com/users/<user ID> \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "state": "deactivated" }'
ricloud-py 사용하기
import ricloud user = ricloud.User.update_with_id(<user ID>, state='deactivated') # OR user = ricloud.User.retrieve(<user ID>) user.update(state='deactivated')