ユーザー
更新しました
ユーザーリソースは、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、またはエンドユーザーのEメールアドレスです。
州
-
active - ユーザーの標準状態
-
deactivated - 所有組織がこのユーザーのアクセスを無効にしました。
-
blocked - API管理者がこのユーザーのアクセスを無効にしました。
POST /users作成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}取得し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 | ひも | ユーザーIDを更新してください。 |
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')
