Documentation

Me (現在のユーザー) の API エンドポイント

GET リクエストを実行して、現在のユーザーについてのユーザー情報を取得します。

GET /api/v1/me/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.055s


{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "type": "user",
            "url": "/api/v1/users/1/",
            "related": {
                "admin_of_organizations": "/api/v1/users/1/admin_of_organizations/",
                "organizations": "/api/v1/users/1/organizations/",
                "credentials": "/api/v1/users/1/credentials/",
                "permissions": "/api/v1/users/1/permissions/",
                "activity_stream": "/api/v1/users/1/activity_stream/",
                "projects": "/api/v1/users/1/projects/",
                "teams": "/api/v1/users/1/teams/"
            },
            "created": "2015-08-25T01:00:07.127Z",
            "username": "admin",
            "first_name": "",
            "last_name": "",
            "email": "[email protected]",
            "is_superuser": true,
            "ldap_dn": ""
        }
    ]
}

以下のフィールドを含む 1 つの結果が返されます。

  • id: ユーザーのデータベース ID (整数)
  • type: ユーザーのデータタイプ (複数選択)
  • user: ユーザー
  • url: ユーザーの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • created: ユーザー作成時のタイムスタンプ (日時)
  • username: 必須。30 文字以下で、英数字および @/./+/-/_ の文字が使用可能 (文字列)
  • first_name: (文字列)
  • last_name: (文字列)
  • email: (email)
  • is_superuser: 明示的にパーミッションを割り当てることなく、このユーザーに全パーミッションがあることを指定します (ブール値)
  • password: パスワード変更用の書き込み専用フィールド (文字列)
  • ldap_dn: (文字列)

ユーザーを修正するには、ユーザーのプライマリー URL (/api/v1/users/N/) を使用します。

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name Me
description Make a GET request to retrieve user information about the current user.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2
types
0 user
actions
GET
id
type integer
label ID
help_text Database ID for this user.
type
type multiple choice
help_text Data type for this user.
choices
0
0 user
1 User
url
type string
help_text URL for this user.
related
type object
help_text Data structure with URLs of related resources.
created
type datetime
help_text Timestamp when this user was created.
username
type string
label username
help_text Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters
first_name
type string
label first name
last_name
type string
label last name
email
type email
label email address
is_superuser
type boolean
label superuser status
help_text Designates that this user has all permissions without explicitly assigning them.
ldap_dn
type string
search_fields
0 username
1 first_name
2 last_name
3 email