Documentation

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

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

GET /api/v2/me/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: localhost
X-API-Time: 0.185s


{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "type": "user",
            "url": "/api/v2/users/1/",
            "related": {
                "admin_of_organizations": "/api/v2/users/1/admin_of_organizations/",
                "organizations": "/api/v2/users/1/organizations/",
                "roles": "/api/v2/users/1/roles/",
                "access_list": "/api/v2/users/1/access_list/",
                "teams": "/api/v2/users/1/teams/",
                "credentials": "/api/v2/users/1/credentials/",
                "activity_stream": "/api/v2/users/1/activity_stream/",
                "projects": "/api/v2/users/1/projects/"
            },
            "summary_fields": {
                "user_capabilities": {
                    "edit": true,
                    "delete": false
                }
            },
            "created": "2017-09-06T02:55:30.492Z",
            "username": "admin",
            "first_name": "",
            "last_name": "",
            "email": "[email protected]",
            "is_superuser": true,
            "is_system_auditor": false,
            "ldap_dn": "",
            "external_account": null,
            "auth": []
        }
    ]
}

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

  • id: ユーザーのデータベース ID (整数)
  • type: ユーザーのデータタイプ (複数選択)
  • user: ユーザー
  • url: ユーザーの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • created: ユーザー作成時のタイムスタンプ (日時)
  • username: 必須。30 文字以下で、英数字および @/./+/-/_ の文字が使用可能 (文字列)
  • first_name: (文字列)
  • last_name: (文字列)
  • email: (email)
  • is_superuser: 明示的にパーミッションを割り当てることなく、このユーザーに全パーミッションがあることを指定します (ブール値)
  • is_system_auditor: (ブール値)
  • ldap_dn: (文字列)
  • external_account: アカウントが外部サービスで管理される場合に設定されます (フィールド)

ユーザーを修正するには、ユーザーのプライマリー URL (/api/v2/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
actions
GET
id
type integer
label ID
help_text Database ID for this user.
type
type choice
label Type
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.
summary_fields
type object
label Summary fields
help_text Data structure with name/description for 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 @/./+/-/_ only.
first_name
type string
label First name
last_name
type string
label Last name
email
type string
label Email address
is_superuser
type boolean
label Superuser status
help_text Designates that this user has all permissions without explicitly assigning them.
is_system_auditor
type boolean
label Is system auditor
ldap_dn
type string
label Ldap dn
external_account
type field
label External account
help_text Set if the account is managed by an external service.
types
0 user
search_fields
0 username
1 first_name
2 last_name
3 email