API docs by Redocly

intdash API specification (v2.7.0)

Download OpenAPI specification:Download

株式会社アプトポッド: VM2M-support@aptpod.co.jp URL: https://www.aptpod.co.jp/

ベースURL

ベースURLは以下のとおりです。APIエンドポイントはこのベースURLから始まります。

https://<host>/api

エンドポイント例:

https://example.intdash.jp/api/v1/measurements
https://example.intdash.jp/api/media/videos

レスポンスのステータスコード

サーバーからクライアントに返却されるHTTPレスポンスのステータスコードは以下のとおりです。

コード 説明
101 Switching Protocols サーバーはプロトコルを切り替えます。
200 OK リクエストは成功しました。
201 Created 新しいリソースが作成されました。
204 No Content リクエストは成功しました。返却するコンテンツはありません。
400 Bad Request 構文が正しくないなどの理由により、リクエストは処理できませんでした。
401 Unauthorized リクエストには認証が必要です。
403 Forbidden アクセス権がないなどの理由により、リクエストは拒否されました。
404 Not Found APIまたはリソースが見つかりません。
405 Method Not Allowed 指定されたメソッドは許可されていません。
409 Conflict 既存のリソースとのコンフリクトのため、リクエストは失敗しました。
500 Internal Server Error サーバーで予期しないエラーが発生したため、リクエストは失敗しました。

注意

リクエストボディのJSONでは、キーの大文字と小文字は区別されません。 従って、以下の2つのリクエストは同じものと見なされます。


{
  "username" : "username",
  "password" : "password"
}


{
  "Username" : "username",
  "Password" : "password"
}

Authorization

Check HTTP Authorization

アクセス制御可能かどうかを判定します。

サブジェクト指定なしの場合

リクエストのスコープのみでアクセス判定を行います。

サブジェクト指定ありの場合

パスの構造から指定したリソースがプロジェクトやグループのリソースかどうか分類し、分類した結果によって処理が決まります。

プロジェクト配下のリソースであると判定した場合

サブジェクトがプロジェクトに所属しているかを確認し、所属している場合は、サブジェクトがメンバーの場合そのプロジェクトにおけるスコープからアクセス判定を行います。 サブジェクトがエッジの場合はリクエストのスコープからアクセス判定を行います。

グループ配下のリソースであると判定した場合

サブジェクトがグループに所属しているかを確認し、所属している場合は、そのグループにおけるスコープからアクセス判定を行います。

パスがその他の場合

リクエストのスコープからアクセス判定を行います。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
subject
string

認証主体を指定します。通常アクセスユーザーのUUIDかアクセスエッジのUUIDを指定します。

scopes
required
Array of strings

スコープを指定します。前述の説明を参照ください。

path
required
string

パス

method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE"

メソッド

Responses

Request samples

Content type
application/json
{
  • "subject": "eb0398f0-3631-470a-abed-0ac3763cf90d",
  • "scopes": [
    ],
  • "path": "/resource/path",
  • "method": "POST"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "result": true
}

Check Me HTTP Authorization

認証ユーザー自身が指定されたパスとメソッドに対してアクセス可能かどうかを判定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
path
required
string

パス

method
required
string
Enum: "GET" "POST" "PUT" "PATCH" "DELETE"

メソッド

Responses

Request samples

Content type
application/json
{
  • "path": "/resource/path",
  • "method": "POST"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "result": true
}

List Roles

ロールのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

name
Array of strings
Example: name=member

ロールの名前による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Get Role

ロールを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
role_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "member",
  • "scopes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List Scopes

スコープのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=4688a07a-0cbc-4597-8c87-538e744bc90d

スコープのUUID

name
Array of strings
Example: name=meas:r

スコープの名前による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Get Scope

スコープを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
scope_uuid
required
string
Example: 4688a07a-0cbc-4597-8c87-538e744bc90d

The Scope UUID.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "4688a07a-0cbc-4597-8c87-538e744bc90d",
  • "name": "meas:r",
  • "allowed_endpoints": [
    ],
  • "allowed_iscp_messages": [
    ],
  • "denied_endpoints": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

OAuth2

Authorization Endpoint

OAuth2認可エンドポイント。 RFC6749:The OAuth 2.0 Authorization Framework

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
client_id
required
string
Example: client_id=client_id

OAuth2クライアントID

response_type
required
string
Value: "code"
Example: response_type=code

OAuth2のresponse_type。 code のみサポートされています。

redirect_uri
required
string
Example: redirect_uri=http://localhost:8080/

認可後のリダイレクト先URI

state
required
string
Example: state=05d54c58385046dd822d233c6adfb9e9

CSRF対策のためのstate

code_challenge
string
Example: code_challenge=ZtNPunH49FD35FWYhT5Tv8I7vRKQJ8uxMaL0_9eHjNA

PKCEコードチャレンジ。 code_verifier から計算したSHA-256ハッシュを、Base64 URLエンコードしたもの。

code_challenge_method
string
Value: "S256"
Example: code_challenge_method=S256

PKCEコードチャレンジの方式。 S256 （SHA-256）のみサポートされます。

Responses

Revoke Token

トークンを無効化します。 このエンドポイントをコールしてからトークンが無効化されるまで、通常数秒程度かかります。 RFC7009:OAuth 2.0 Token Revocation

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/x-www-form-urlencoded
client_id
required
string

OAuth2クライアントID

token_type_hint
any
Default: "refresh_token"
Enum: "access_token" "refresh_token"

OAuth2トークンタイプについてのヒント

token
string

無効化したいリフレッシュトークンまたはアクセストークン。 指定を省略した場合、サーバーは、cookieの _bearer_token に指定されたアクセストークン、または、Authorizationヘッダーに指定されたアクセストークン（ Bearer トークン）を無効化します。

Responses

Request samples

Content type
application/x-www-form-urlencoded
client_id=99dcf67c_default.aptpod.co.jp&token=eyJhbGciOiJSUzI1NiIsImtpZCI6ImNkY2M4NjAxZGNiMTY2ODg5MTAyNjY5OWY2MmQ5ZDEyNGIxMTcwZmQ4OWU2YTgxNTkyNGIwNDIwZWQ2MDM0NWYiLCJ0eXAiOiJKV1QifQ.eyJleHAiOjE1ODA5NTQ5NzgsImlhdCI6MTU4MDk1MTM3OCwiaXNzIjoibWljcm8tYXV0aCJ9.Xmi5TgHRiXIaVZXtfCxPNEIWrJMusmlqImA2d7uTZDtnUh6Cv_RvbLgChVsyl5hPFNDXU-Bm4-Nh8ppQVJpHQhVYPeVlycMXhKXdlx_kNJoBA8tJ4BgZlQObt16ZzakZIoYJBH8ffWkWxDYGVswVFRaB4e4EfsaOa3jGP15jK9g&token_type_hint=refresh_token

List JSON Web Keys

JSON Web Keysのリストを取得します。 RFC7517:JSON Web Key

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/jwk-set+json; charset=utf-8
{
  • "keys": [
    ]
}

Token Endpoint

OAuth2のアクセストークンを取得します。 RFC6749:The OAuth 2.0 Authorization Framework

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/x-www-form-urlencoded
grant_type
any
Enum: "password" "authorization_code" "refresh_token" "client_credentials"

グラントタイプ

refresh_token
string

認可時に発行されたリフレッシュトークン。grant_typeが refresh_token の場合にだけ指定します。

tenant_uuid
string
Default: "00000000-0000-0000-0000-000000000000"

テナントのUUID。grant_typeが password の場合にだけ指定します。 grant_typeが password で、テナントUUIDを省略した場合は、デフォルトのテナントが使用されます。

username
string

ユーザーの名前。grant_typeが password の場合にだけ指定します。

password
string

パスワード。grant_typeが password の場合にだけ指定します。

client_id
string

OAuth2クライアントのID

client_secret
string

OAuth2のクライアントシークレット。 OAuth2クライアントの token_endpoint_auth_method が client_secret_post の場合にだけ指定します。

client_certification
string

OAuth2のクライアント証明書。 OAuth2クライアントの token_endpoint_auth_method が tls_client_auth の場合にだけ指定します。

redirect_uri
string

認可後のリダイレクト先URI。 grant_typeが authorization_code の場合にだけ必要です。

code_verifier
string

PKCE code verifier.

  • 使用可能な文字: [a-Z] / [0-9] / "-" / "." / "_" / "~"
  • 長さ: 43文字以上、128文字以下
code
string

認可コード

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
grant_type=password&username=username%40example.com&password=password&client_id=99dcf67c_default.aptpod.co.jp

Response samples

Content type
application/json; charset=utf-8
{
  • "token_type": "bearer",
  • "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImNkY2M4NjAxZGNiMTY2ODg5MTAyNjY5OWY2MmQ5ZDEyNGIxMTcwZmQ4OWU2YTgxNTkyNGIwNDIwZWQ2MDM0NWYiLCJ0eXAiOiJKV1QifQ.eyJleHAiOjE1ODA5NTQ5NzgsImlhdCI6MTU4MDk1MTM3OCwiaXNzIjoibWljcm8tYXV0aCJ9.Xmi5TgHRiXIaVZXtfCxPNEIWrJMusmlqImA2d7uTZDtnUh6Cv_RvbLgChVsyl5hPFNDXU-Bm4-Nh8ppQVJpHQhVYPeVlycMXhKXdlx_kNJoBA8tJ4BgZlQObt16ZzakZIoYJBH8ffWkWxDYGVswVFRaB4e4EfsaOa3jGP15jK9g",
  • "expires_in": 3600,
  • "refresh_token": "lv70VlZ92fLAKiNT5qzOi684K0R5ZVcPjtAhCo_A_0I.iUIeiUrBVR9OoM9y_QBzSVzAgXvJ-8AYANCA1WEx_Lw",
  • "refresh_token_expires_in": 2592000,
  • "scope": ""
}

OAuth2 Clients

List OAuth2Clients

OAuth2クライアントのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
id
Array of strings
Example: id=039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

name
Array of strings
Example: name=client_name

名前による部分一致検索

sort
string
Default: "name+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

  • name
  • created_at
  • updated_at
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Get OAuth2Client

OAuth2クライアントを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update OAuth2Client

OAuth2クライアントを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Request Body schema: application/json
name
string [ 1 .. 256 ] characters

名前

redirect_uris
Array of strings <= 10 items [ items <= 256 characters ]

認可後のリダイレクト先URI

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete OAuth2Client

OAuth2クライアントを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

List User's OAuth2Clients

ユーザーのOAuth2クライアントのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Authenticated User's OAuth2 Clients

List My OAuth2Clients

自分（ユーザー）のOAuth2クライアントのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create My OAuth2Client

自分（ユーザー）のOAuth2クライアントを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

名前

grant_type
required
string

グラントタイプ

redirect_uris
required
Array of strings <= 10 items [ items <= 256 characters ]
token_endpoint_auth_method
required
string
Default: "client_secret_post"
Enum: "client_secret_post" "tls_client_auth" "client_secret_basic" "none"

トークンエンドポイントの認証方式

tls_client_auth_subject_dn
string <= 512 characters

TLSクライアント認証のサブジェクトDN

Responses

Request samples

Content type
application/json
Example
{
  • "name": "my-authorization-code-client",
  • "grant_type": "authorization_code",
  • "token_endpoint_auth_method": "client_secret_basic",
  • "redirect_uris": []
}

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "string",
  • "name": "string",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "string",
  • "redirect_uris": [
    ],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z",
  • "client_secret": "string"
}

Get My OAuth2Client

自分（ユーザー）のOAuth2クライアントを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My OAuth2Client

自分（ユーザー）のOAuth2クライアントを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Request Body schema: application/json
name
string [ 1 .. 256 ] characters

名前

redirect_uris
Array of strings <= 10 items [ items <= 256 characters ]

認可後のリダイレクト先URI

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json; charset=utf-8
{
  • "client_id": "4b54d475-0607-441e-b252-944a97337a9e",
  • "name": "My Client",
  • "secrets": [
    ],
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "none",
  • "redirect_uris": [],
  • "response_types": [
    ],
  • "scopes": [
    ],
  • "audiences": [
    ],
  • "tls_client_auth_subject_dn": "SERIALNUMBER=0001,CN=CommonName,OU=OrganizationalUnit,O=Organization,POSTALCODE=PostalCode,STREET=StreetAddress,L=Locality,ST=Province,C=COUNTRY",
  • "user_uuid": "bde29eb4-c3cf-4dca-8463-04118a0904b6",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My OAuth2Client

自分（ユーザー）のOAuth2クライアントを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Responses

Create My OAuth2Client Secret

OAuth2クライアントシークレットを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

Request Body schema: application/json
name
string [ 1 .. 511 ] characters

Secretの名前

Responses

Request samples

Content type
application/json
{
  • "name": "MySecret"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "My Secret",
  • "secret": "secret",
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z"
}

Delete My OAuth2Client Secret

OAuth2クライアントシークレットを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
client_id
required
string
Example: 039b8ee2-8edc-46e4-9a88-4d03bac142f7

OAuth2クライアントID

secret_id
required
integer
Example: 1

OAuth2クライアントシークレットのID

Responses

Users

List Users

ユーザーのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

role_uuid
Array of strings
Example: role_uuid=af22c56b-6b3e-4807-a165-07e9dbd7e25b

ロールのUUID

name
Array of strings
Example: name=intdash

ユーザーの名前による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

nickname
Array of strings
Example: nickname=intdash-nickname

ユーザーの表示名による部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

email
Array of strings
Example: email=intdash@example.com

メールアドレスによる部分一致検索。文字列をダブルクォーテーションで囲むと、完全一致のものだけを取得します。

disabled
boolean
  • true を指定した場合、無効化されているユーザーのみを取得します。
  • false を指定した場合、有効なユーザーのみを取得します。
  • 指定を省略した場合、有効／無効にかかわらずユーザーを取得します。
is_super
boolean
  • true を指定した場合、スーパーユーザーのみを取得します。
  • false を指定した場合、スーパーユーザー以外を取得します。
  • 指定を省略した場合、スーパーユーザーであるかにかかわらずユーザーを取得します。
is_temporary
boolean
  • true を指定した場合、一時パスワードを使用しているユーザーのみを取得します。
  • false を指定した場合、パスワードを設定済みのユーザーのみを取得します。
  • 指定を省略した場合、一時パスワードを使用しているかにかかわらずユーザーを取得します。
min_sign_in_attempt_count
integer >= 0
Example: min_sign_in_attempt_count=1

ログイン失敗回数の最小値。ログイン失敗回数がこの数値以上のユーザーを取得します。

max_sign_in_attempt_count
integer >= 0
Example: max_sign_in_attempt_count=10

ログイン失敗回数の最大値。ログイン失敗回数がこの数値以下のユーザーを取得します。

sort
string
Default: "name+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

  • name
  • created_at
  • updated_at
  • last_sign_in_at
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create User

ユーザーを作成します。新しいユーザーには自動生成された一時パスワードが設定されます。 ユーザー作成のリクエストにメールアドレス（ email ）が含まれていた場合は、 そのメールアドレスに確認メールが送信されます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters ^[0-9a-zA-Z-_]*$

ユーザーの名前

nickname
string <= 512 characters

ユーザーの表示名

description
string <= 65536 characters

ユーザーの説明

role_uuids
required
Array of strings

ロールのUUID。指定したロールがユーザーに割り当てられます。

email
string [ 1 .. 256 ] characters

ユーザーのメールアドレス

Responses

Request samples

Content type
application/json
{
  • "name": "intdash",
  • "nickname": "nickname",
  • "description": "description",
  • "role_uuids": [
    ],
  • "email": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "password": {
    },
  • "roles": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get User

ユーザーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update User

ユーザーを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
name
string [ 1 .. 256 ] characters ^[0-9a-zA-Z-_]*$

ユーザーの名前

nickname
string <= 512 characters

ユーザーの表示名

description
string <= 65536 characters

ユーザーの説明

Responses

Request samples

Content type
application/json
{
  • "name": "username",
  • "nickname": "nickname",
  • "description": "user description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete User

ユーザーを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "type": "forbidden",
  • "title": "error message"
}

Enable User

ユーザーを有効化します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Disable User

ユーザーを無効化します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List User's Roles

ユーザーのロールのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Assign Role

ユーザーにロールを割り当てます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

role_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "member",
  • "scopes": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Unassign Role

ユーザーへのロールの割り当てを解除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

role_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

ロールのUUID

Responses

User's Emails

Set Email as Verified

メールアドレスを確認済みにします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
verification_token
required
string [ 1 .. 4096 ] characters

メールアドレス確認用トークン

Responses

Request samples

Content type
application/json
{
  • "verification_token": "verification.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Create Email

ユーザーのメールアドレスを設定します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Email

ユーザーのメールアドレスを更新します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Email

ユーザーのメールアドレスを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Send Verification Email

メールアドレスを確認するため確認メールを送信します。メールアドレス確認用トークンを使用します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "email_id": "1",
  • "expired_at": "2100-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Set Email as Verified

ユーザーのメールアドレスを確認済みにします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
verification_token
required
string [ 1 .. 4096 ] characters

メールアドレス確認用トークン

Responses

Request samples

Content type
application/json
{
  • "verification_token": "verification.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

User's Password

Create Temporary Password

ユーザーのパスワードを、ランダムな一時パスワードに変更します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "attempt_count": 0,
  • "is_temporary": true,
  • "temporary_password": "password",
  • "last_attempt_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Unlock Password

ユーザーのパスワードのロックを解除します。このユーザーのログイン失敗回数は0にリセットされます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "attempt_count": 0,
  • "is_temporary": false,
  • "last_attempt_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

User's API Tokens

Introspect API Token

APIトークンの検証を行います。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json; charset=utf-8
token
required
string

APIトークン

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "token": "message.signature"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "active": false
}

List API Tokens

ユーザーのAPIトークンのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create API Token

ユーザーのAPIトークンを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

APIトークンの名前

expired_at
string <date-time>

有効期限

Responses

Request samples

Content type
application/json
{
  • "name": "for test",
  • "expired_at": "2000-01-02T03:04:05.00Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "craeted",
  • "token": "token.signature",
  • "scopes": [
    ],
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update API Token

ユーザーのAPIトークンを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Request Body schema: application/json; charset=utf-8
name
required
string <= 256 characters

APIトークンの名前

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "for test"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "for test",
  • "token": "token",
  • "scopes": [
    ],
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete API Token

ユーザーのAPIトークンを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Responses

Authenticated User

Get Me

自分（ユーザー）を取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Me

自分（ユーザー）を更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
string [ 1 .. 256 ] characters ^[0-9a-zA-Z-_]*$

ユーザーの名前

nickname
string <= 512 characters

ユーザーの表示名

description
string <= 65536 characters

ユーザーの説明

Responses

Request samples

Content type
application/json
{
  • "name": "username",
  • "nickname": "nickname",
  • "description": "user description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "name": "intdash",
  • "nickname": "intdash-nickname",
  • "disabled": false,
  • "description": "description",
  • "is_super": false,
  • "emails": [
    ],
  • "last_sign_in_at": "2000-01-01T00:00:00Z",
  • "roles": [
    ],
  • "password": {
    },
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

List My Roles

自分（ユーザー）に割り当てられたロールのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Authenticated User's Emails

Create My Email

自分（ユーザー）のメールアドレスを設定します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My Email

自分（ユーザー）のメールアドレスを更新します。 メールアドレスの設定が成功すると、確認用URLを含むメールがそのアドレスに送信されます。 確認用URLには、メールアドレス確認用トークンとメールアドレスのIDが含まれます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Request Body schema: application/json
address
required
string [ 1 .. 256 ] characters

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "intdash@example.com"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "address": "intdash@example.com",
  • "verified": false,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My Email

自分（ユーザー）のメールアドレスを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Send Verification Email to Me

メールアドレスを確認するための確認メールを送信します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_email_id
required
integer <int64>
Example: 1

ユーザーのメールアドレスのID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "email_id": "1",
  • "expired_at": "2100-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Authenticated User's Password

Change Password

パスワードを変更します。 現在のパスワード old_password または recovery_token が必要です。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
password
required
string [ 8 .. 512 ] characters [a-zA-Z0-9!"#$%&'()*+,-./:;<=>?@\{\}|\[\]]*

新しいパスワード

old_password
string <= 512 characters

現在のパスワード

recovery_token
string

リカバリートークン。パスワード再設定用の確認メールに含まれています。

Responses

Request samples

Content type
application/json
{
  • "password": "new-password",
  • "old_password": "old-password",
  • "recovery_token": "recovery.token"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "attempt_count": 1,
  • "is_temporary": false,
  • "last_attempt_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Check Password

パスワードがポリシーに適合しているかをチェックします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json; charset=utf-8
password
required
string <= 512 characters

チェックしたいパスワード

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "password": "password"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "valid": false,
  • "errors": [
    ]
}

Authenticated User's API Tokens

List My API Tokens

自分（ユーザー）のAPIトークンのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create My API Token

自分（ユーザー）のAPIトークンを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

APIトークンの名前

expired_at
string <date-time>

有効期限

Responses

Request samples

Content type
application/json
{
  • "name": "for test",
  • "expired_at": "2000-01-02T03:04:05.00Z"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "craeted",
  • "token": "token.signature",
  • "scopes": [
    ],
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My API Token

自分（ユーザー）のAPIトークンを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Request Body schema: application/json; charset=utf-8
name
required
string <= 256 characters

APIトークンの名前

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "for test"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "for test",
  • "token": "token",
  • "scopes": [
    ],
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "expired_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My API Token

自分（ユーザー）のAPIトークンを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_api_token_id
required
integer <int64>
Example: 1

APIトークンのID

Responses

Edges

List Edges

エッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
uuid
Array of strings
Example: uuid=0932ff17-567c-4ac8-a40d-136357890f7b

エッジのUUID

name
Array of strings
Example: name=edge_name

名前による部分一致検索

nickname
Array of strings
Example: nickname=edge_nickname

表示名による部分一致検索

owner_uuid
Array of strings
Example: owner_uuid=d30267f0-bdd4-4d53-b072-45d3cc29c7de

所有者ユーザーのUUID

has_owner
string
Enum: "true" "false"
Example: has_owner=true

所有者の有無。

  • true : 所有者が設定されているエッジを取得します。
  • false : 所有者が設定されていないエッジを取得します。
sort
string
Default: "name+"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

  • name
  • created_at
  • updated_at
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create Edge

所有者がない状態でエッジを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Edge having the same UUID as Me

自分のUUIDと同じエッジUUIDを持つエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Edge

エッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Edge

エッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge_name",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Edge

エッジを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Assign Owner

エッジに所有者を割り当てます。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
user_uuid
required
string

所有者とするユーザーのUUID

Responses

Request samples

Content type
application/json
{
  • "user_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "84693d9e-0f1a-457b-b417-a7c697cffdce"
}

Unassign Owner

エッジに所有者がない状態にします。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

List User's Edges

指定されたユーザーが所有するエッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create User's Edge

指定されたユーザーを所有者とするエッジを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get User's Edge

ユーザーが所有するエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update User's Edge

ユーザーが所有するエッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge_name",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete User's Edge

ユーザーが所有するエッジを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Edge's Secrets

Create Edge's Secret

EdgeのOAuth2クライアントシークレットを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 511 ] characters

Secretの名前

Responses

Request samples

Content type
application/json
{
  • "name": "MySecret"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "My Secret",
  • "secret": "secret",
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z"
}

Delete Edge's Secret

EdgeのOAuth2クライアントシークレットを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

secret_id
required
integer
Example: 1

OAuth2クライアントシークレットのID

Responses

Authenticated User's Edges

List My Edges

自分（ユーザー）が所有するエッジのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [
    ],
  • "page": {
    }
}

Create My Edge

新しいエッジを作成し、自分（ユーザー）を所有者に設定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get My Edge

自分（ユーザー）が所有するエッジを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Create My Edge with UUID

指定したUUIDを持つ新しいエッジを作成し、自分を所有者に設定します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge-with-uuid",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update My Edge

自分（ユーザー）が所有するエッジを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_]*$

エッジの名前

nickname
string <= 511 characters

エッジの表示名

description
string <= 65535 characters

エッジの説明

Responses

Request samples

Content type
application/json
{
  • "name": "edge_name",
  • "nickname": "nickname",
  • "description": "description"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-edge",
  • "nickname": "My Edge",
  • "description": "Description",
  • "owner": {
    },
  • "client_secret": "secret",
  • "secrets": [
    ],
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete My Edge

自分（ユーザー）が所有するエッジを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Responses

Secrets of Authenticated User's Edge

Create My Edge Secret

EdgeのOAuth2クライアントシークレットを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

Request Body schema: application/json
name
string [ 1 .. 511 ] characters

Secretの名前

Responses

Request samples

Content type
application/json
{
  • "name": "MySecret"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 1,
  • "name": "My Secret",
  • "secret": "secret",
  • "last_used_at": "2000-01-01T00:00:00Z",
  • "created_at": "2000-01-01T00:00:00Z"
}

Delete My Edge Secret

EdgeのOAuth2クライアントシークレットを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
edge_uuid
required
string
Example: e920a50c-ddde-4571-b066-b568340de7cf

エッジのUUID

secret_id
required
integer
Example: 1

OAuth2クライアントシークレットのID

Responses

Groups

List My Groups

自分（ユーザー）が所属するグループのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

List Groups

グループのリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create Group

グループを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
Request Body schema: application/json
name
required
string (GroupName) [ 1 .. 255 ] characters

グループの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-group"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-group",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Group

グループを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "parent_group_uuid": "76b35658-9d77-40d0-8ef8-5c3f520db30d",
  • "name": "intdash",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Update Group

グループを更新します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
name
string (GroupName) [ 1 .. 255 ] characters

グループの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-group"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "parent_group_uuid": "76b35658-9d77-40d0-8ef8-5c3f520db30d",
  • "name": "intdash",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Delete Group

グループを削除します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Responses

List Sub-groups

サブグループを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

query Parameters
page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Create Sub-group

サブグループを作成します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
name
required
string (GroupName) [ 1 .. 255 ] characters

グループの名前

Responses

Request samples

Content type
application/json
{
  • "name": "my-group"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "my-group",
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Group Members

List Group Members

グループメンバーリストを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

query Parameters
is_owner
boolean
  • true を指定した場合、オーナーのみを取得します。
  • false を指定した場合、オーナー以外を取得します。
  • 指定を省略した場合、オーナーであるかにかかわらずメンバーを取得します。
user_uuid
Array of strings
Example: user_uuid=b7f5f259-6a63-4a26-bfa3-e15240cbc0b7

ユーザーのUUID

page
integer >= 1
Default: 1

取得するページの番号

per_page
integer <= 200
Default: 30

1回のリクエストで取得する件数

sort
string
Enum: "created_at" "created_at+" "created_at-" "updated_at" "updated_at+" "updated_at-" "name" "name+" "name-"

並べ替えに使用するキー。接尾辞 + を付けた場合は昇順、 - を付けた場合は降順で出力されます。 接尾辞を省略した場合は昇順となります。 例えば、 name- を指定すると、nameによる降順で出力されます。

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "items": [ ],
  • "page": {
    }
}

Add Group Member

グループメンバーを追加します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

Request Body schema: application/json
user_email_address
string <= 512 characters

ユーザーのメールアドレス。user_uuid といずれか必須です。user_uuid を優先します。

user_uuid
string <= 36 characters

ユーザーのUUID。user_email_address といずれか必須です。user_uuid を優先します。

role_uuids
required
Array of strings (RoleUUIDs) [ items <= 36 characters ]

ユーザーに割り当てるロールのUUID。オーナーのロールUUIDは変更できません。

Responses

Request samples

Content type
application/json
{
  • "user_email_address": "intdash@example.com",
  • "user_uuid": "0932ff17-567c-4ac8-a40d-136357890f7b",
  • "role_uuids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [
    ],
  • "inherited_role_uuids": [
    ],
  • "role_uuids": [
    ],
  • "is_owner": true,
  • "created_at": "2000-01-01T00:00:00Z",
  • "updated_at": "2000-01-01T00:00:00Z"
}

Get Group Member

グループメンバーを取得します。

Authorizations:
IntdashTokenOAuth2TokenInHeaderOAuth2TokenInCookie
path Parameters
group_uuid
required
string
Example: 6b4f4bce-ba32-4ad9-b808-39e2d68b33ee

グループのUUID

user_uuid
required
string
Example: 0932ff17-567c-4ac8-a40d-136357890f7b

ユーザーのUUID

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "user_uuid": "6b4f4bce-ba32-4ad9-b808-39e2d68b33ee",
  • "name": "username",
  • "emails": [