DeployGate

Suggest Edits

DeployGate API

DeployGateのアプリやユーザーを管理することができるAPIです

DeployGate APIを使うと、ご利用中のDeployGateアカウントをプログラムから操作することができます。このリファレンスページでは、APIの一覧と実際にリクエストを行える Try It 機能を提供しています。

制限事項について

各 API は、 Try It にて実際のリクエストを発行できますが、ファイルのアップロードは行うことができません。 Upload API は curl コマンドなどでお試しください。

Suggest Edits

アプリのアップロード

テストサーバや自作ツールから簡単に自動アップロードできます。

posthttps://deploygate.com/api/users/owner/apps

curl \
  -F "token=xxx" \
  -F "file=@sample.apk" \
  -F "message=sample" \
  https://deploygate.com/api/users/_your_name_/apps

curl \
  -F "token=xxx" \
  -F "file=@sample.apk" \
  -F "message=sample" \
  -F "distribution_key=abcd1234" \
  -F "release_note=new build" \
  https://deploygate.com/api/users/_your_name_/apps

GIT_HASH=$(git rev-parse --short HEAD)
GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
curl \
  -F "token=xxx" \
  -F "file=@sample.apk" \
  -F "message=git:$GIT_HASH" \
  -F "distribution_name=$GIT_BRANCH" \
  https://deploygate.com/api/users/_your_name_/apps

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

400 Bad Request

{
   "error":false,
   "results":{
      "name":"DeployGate",
      "package_name":"com.deploygate",
      "secret":"1234567890abcdef1234567890abcdef12345678",
      "labels":{
         "ja":"DeployGate",
      },
      "os_name":"Android",
      "path":"/users/_your_name_/apps/com.deploygate",
      "revision":1,
      "version_code":"36",
      "version_name":"1.6.0",
      "sdk_version":"7",
      "target_sdk_version":23,
      "signature":"1234567890abcdef1234567890abcdef12345678",
      "message":"sample",
      "file":"https://xxx",
      "md5":"1234567890abcdef1234567890abcdef",
      "icon":"https://yyy",
      "user":{
         "id":1,
         "name":"_your_name_",
         "profile_icon":"https://zzz"
      }
   }
}

{
  "error": true,
  "message": "application create error: cannot detect the package.",
  "because": "application create error: cannot detect the package."
}

Path Params

owner

string

required

ユーザー名もしくはグループ名

Body Params

file

file

required

アプリケーションのバイナリファイル(IPA/APK)

message

string

アップロードするファイルの説明

distribution_key

string

配布ページのハッシュ (配布ページURLの /distributions/xxxx の xxxx 部分) を指定するとその配布ページも同時に更新します。

distribution_name

string

更新する配布ページを名前で指定できます。存在しない場合は新しい配布ページが作成されます。Gitのブランチ名ごとに配布ページを作るなどの使い方が可能です。

release_note

string

配布ページアプリ更新時に付与するメッセージ。

disable_notify

boolean

(iOSのみ) 値に yes を設定するとPush時のメール通知を無効にします。

visibility

string

新しくアップロードするアプリのプライバシー設定を private か public で指定します。Personal Free プランの場合のみ public 、その他のプランでは private がデフォルトになります。更新時には無視されます。

Suggest Edits

アプリにユーザーを招待

ユーザーが所有するアプリに別のユーザーを招待できます。(グループは専用のAPIをご利用ください)

posthttps://deploygate.com/api/users/owner/platforms/platform/apps/app_id/members

cURL

curl \
  -F 'token=xxx' \
  -F 'users=existing_user,new_user@example.com' \
  https://deploygate.com/api/users/_your_name_/platforms/android/apps/com.deploygate.sample/members

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

400 Bad Request

{
  "error": false,
  "results": {
    "invite": "member invite success",
    "added": [
      {
        "name": "existing_user",
        "role": 2
      }
    ],
    "invited": [
      {
        "name": "new_user@example.com",
        "role": 2
      }
    ]
  }
}

{
  "error": true,
  "message": "tried to invite existing member",
  "because": "tried to invite existing member"
}

Path Params

owner

string

required

アプリを所有するユーザー名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

Body Params

users

string

required

ユーザー名もしくはメールアドレス、カンマ(,)区切りで複数指定可能

role

string

(旧Free/Lite/Pro/Bizプランのみ) 開発者として追加する場合1、テスターとして追加する場合は2を指定してください

Suggest Edits

アプリのユーザーを取得する

gethttps://deploygate.com/api/users/owner/platforms/platform/apps/app_id/members

cURL

curl　"https://deploygate.com/api/users/_your_name_/platforms/android/apps/com.deploygate.sample/members?token=xxx"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "results": {
    "usage": {
      "used": 2,
      "max": 1000
    },
    "users": [
      {
        "name": "existing_user",
        "role": 2
      },
      {
        "name": "another_user",
        "role": 2
      }
    ]
  }
}

Path Params

owner

string

required

アプリを所有するユーザー名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

レスポンスにアプリの所有者自身は含まれません

Suggest Edits

アプリからユーザーを削除

deletehttps://deploygate.com/api/users/owner/platforms/platform/apps/app_id/members

cURL

curl \
  -X DELETE
  -F 'token=xxx' \
  -F 'users=existing_user,non_member' \
  https://deploygate.com/api/users/_your_name_/platforms/android/apps/com.deploygate.sample/members

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

400 Bad Request

{
  "error": false,
  "results": {
    "invite": "member remove success(Warning: some users were not a member [ non_member ])"
  }
}

{
  "error": true,
  "message": "tried to invite existing member",
  "because": "tried to invite existing member"
}

Path Params

owner

string

required

アプリを所有するユーザー名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

Body Params

users

string

required

ユーザー名もしくはメールアドレス、カンマ(,)区切りで複数指定可能

Suggest Edits

アプリに参加しているチーム一覧を取得

この操作はグループが所有するアプリにのみ使用できます

gethttps://deploygate.com/api/organizations/organization_name/platforms/platform/apps/app_id/teams

cURL

curl "https://deploygate.com/api/organizations/_organization_name_/platforms/_platform_/apps/_app_id_/teams?token=xxx"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "teams": [
    {
      "name": "チーム名",
      "role": "owner",
      "member_count": 1
    }
  ]
}

Path Params

organization_name

string

required

グループ名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

Suggest Edits

アプリにチームを追加する

この操作はグループが所有するアプリにのみ使用できます

posthttps://deploygate.com/api/organizations/organization_name/platforms/platform/apps/app_id/teams

cURL

curl \
-F "token=xxx" \
-F "team=チーム名" \
/organizations/_organization_name_/platforms/_platform_/apps/_app_id_/teams

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

201 Created

Path Params

organization_name

string

required

グループ名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

Body Params

team

string

required

追加するチーム名

Suggest Edits

アプリからチームを削除する

この操作はグループが所有するアプリにのみ使用できます

deletehttps://deploygate.com/api/organizations/organization_name/platforms/platform/apps/app_id/teams/team_name

cURL

curl \
  -X DELETE
  -F 'token=xxx' \
/organizations/_organization_name_/platforms/_platform_/apps/_app_id_/teams/_team_name_

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "message": "チーム名 was leaved from アプリ名(グループ名)"
}

Path Params

organization_name

string

required

グループ名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

team_name

string

required

削除するチーム名

Suggest Edits

アプリに参加している共有チーム一覧を取得

この操作はエンタープライズグループが所有するアプリにのみ使用できます

gethttps://deploygate.com/api/organizations/organization_name/platforms/platform/apps/app_id/shared_teams

cURL

curl "https://deploygate.com/api/organizations/_organization_name_/platforms/_platform_/apps/_app_id_/shared_teams?token=xxx"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "teams": [
    {
      "name": "チーム名",
      "role": "owner",
      "member_count": 1
    }
  ]
}

Path Params

organization_name

string

required

グループ名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

Suggest Edits

アプリに共有チームを追加する

この操作はエンタープライズグループが所有するアプリにのみ使用できます

posthttps://deploygate.com/api/organizations/organization_name/platforms/platform/apps/app_id/shared_teams

cURL

curl \
-F "token=xxx" \
-F "team=チーム名" \
/organizations/_organization_name_/platforms/_platform_/apps/_app_id_/shared_teams

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

201 Created

Path Params

organization_name

string

required

グループ名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

Body Params

team

string

required

追加するチーム名

Suggest Edits

アプリから共有チームを削除する

この操作はエンタープライズグループが所有するアプリにのみ使用できます

deletehttps://deploygate.com/api/organizations/organization_name/platforms/platform/apps/app_id/shared_teams/team_name

cURL

curl \
  -X DELETE
  -F 'token=xxx' \
/organizations/_organization_name_/platforms/_platform_/apps/_app_id_/shared_teams/_team_name_

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "message": "チーム名 was leaved from アプリ名(グループ名)"
}

Path Params

organization_name

string

required

グループ名

platform

string

required

ios もしくは android

app_id

string

required

アプリのパッケージ名 (例: com.deploygate.android)

team_name

string

required

削除するチーム名

Suggest Edits

グループAPIの利用に関する注意事項

グループのAPI Key

グループ関連APIを使用する場合、tokenパラメータにユーザーのAPI Keyに加えて、グループのAPI Keyを利用することができます。（一覧取得と作成を除く）

グループのAPI Keyを使用することで、特定のユーザに紐付かない状態で操作を行うことができます。グループのAPI Keyによるアクセスを行う場合の権限は管理者となり、すべての操作を行うことができます。

Suggest Edits

グループ一覧の取得

現在のユーザーが所属しているグループの一覧を取得します

gethttps://deploygate.com/api/organizations

curl

curl "https://deploygate.com/api/organizations?token=XXXXXXXX"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

400 グループのAPIキーでアクセスした場合

{  
  "error":false,
  "organizations":[  
    {  
      "type":"Organization",
      "name":"ExampleOrganization",
      "description":"This is an organization",
      "url":"https://deploygate.com/organizations/ExampleOrganization"
    },
    {  
      "type":"Organization",
      "name":"ExampleEnterpriseOrganization",
      "description":"This is an organization created in Enterprise",
      "url":"https://deploygate.com/organizations/ExampleEnterpriseOrganization",
      "enterprise":{  
        "type":"Enterprise",
        "name":"ExampleEnterprise",
        "display_name":"Example Enterprise Inc.",
        "url":"https://rai.dgtest.info/enterprises/ExampleEnterprise",
        "icon_url":"/img/icons/enterprise-default-thumb.png"
      }
    }
  ]
}

{  
  "error":true,
  "message":"requester must be a user",
  "because":"requester must be a user"
}

グループのAPIキーではご利用いただけません

Suggest Edits

グループを作成する

新しいグループを作成します

posthttps://deploygate.com/api/organizations

cURL

curl \
  -F "token=XXX" \
  -F "name=ExampleOrganization" \
  -F "description=This is Example Organization created via API"
  -F "billing_email=billings@deploygate.com"
  -F "plan=startup"
  https://deploygate.com/api/organizations

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

201 Created

400 グループのAPIキーでアクセスした場合

{  
  "error":false,
  "organization":{  
    "type":"Organization",
    "name":"ExampleOrganization",
    "description":"This is Example Organization created via API",
    "url":"https://deploygate.com/organizations/ExampleOrganization"
  }
}

{  
  "error":true,
  "message":"requester must be a user",
  "because":"requester must be a user"
}

Body Params

name

string

required

グループ名。3文字以上でアルファベット、数字と - が使用可能です。先頭に数字と-、末尾に-は使用できません。

description

string

グループの表示上の説明文を設定します

plan

string

プランを startup, business, large_business のいずれかで指定します。省略時は startup となります。

billing_email

string

請求に関するメールを送信する先を設定します

呼び出したユーザーが自動的にオーナーチームに追加されます
いずれの plan も作成後30日間は無料で利用可能ですが、その後も継続してご利用いただく場合はお支払い情報をご登録いただく必要があります

Suggest Edits

グループの情報を取得する

gethttps://deploygate.com/api/organizations/organization_name

cURL

curl "https://deploygate.com/api/organizations/ExampleOrganization?token=XXXXXXXX"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "organization": {
    "type": "Organization",
    "name": "ExampleOrganization",
    "description": "This is Example Organization created via API",
    "url": "https://deploygate.com/organizations/ExampleOrganization"
  }
}

Path Params

organization_name

string

required

グループ名

Suggest Edits

グループの説明文を変更する

patchhttps://deploygate.com/api/organizations/organization_name

cURL

curl \
  -X PATCH
  -F "token=XXXXXXXX" \
  -F "description=Updated description" \
  https://deploygate.com/api/organizations/ExampleOrganization

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{  
  "error":false,
  "organization":{  
    "type":"Organization",
    "name":"ExampleOrganization",
    "description":"Updated description",
    "url":"https://deploygate.com/organizations/ExampleOrganization"
  }
}

Path Params

organization_name

string

required

グループ名

Body Params

description

string

グループの表示上の説明文

Suggest Edits

グループを削除する

グループを削除すると、グループ内に存在するすべてのチームとアプリケーションも削除されます
Startup, Business, Large Business プランをご契約状態のグループは削除できません。事前にPayPal ないし請求書払いをご解約いただく必要があります。

Suggest Edits

グループのメンバーの一覧を取得

グループに所属しているメンバーのユーザー情報一覧を取得します。

gethttps://deploygate.com/api/organizations/organization_name/members

cURL

curl　"https://deploygate.com/api/organizations/_organization_name_/members?token=xxx"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "members": [
    {
      "type": "User",
      "name": "foo",
      "icon_url": "https://secure.gravatar.com/avatar/foo",
      "url": "https://deploygate.com/users/foo"
    },
    {
      "type": "User",
      "name": "invitee@test.com",
      "icon_url": "https://secure.gravatar.com/avatar/default",
      "inviting": true,
      "url": "https://deploygate.com/users/invitee@test.com"
    }
  ]
}

Path Params

organization_name

string

required

グループ名

招待中のユーザー

招待状を送付済みであるが、まだDeployGateへの登録を完了していないユーザーは、"inviting": true が付与され一覧に表示されます。また、その場合のユーザ名はメールアドレスとなります。

Suggest Edits

グループにメンバーを追加

新しいユーザーをグループのメンバーに追加します。もし対象がDeployGateの登録ユーザで無い場合は、招待状を送付します。

posthttps://deploygate.com/api/organizations/organization_name/members

cURL

curl \
  -F "username=invitee" \
  -F "token=XXX" \
  https://deploygate.com/api/organizations/_organization_name_/members

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "message": "invitee@test.com was invited to sample-organization"
}

Path Params

organization_name

string

required

グループ名

Query Params

username

string

DeployGateのユーザ名

email

string

DeployGateに登録しているメールアドレス、もしくは、招待状を送付する宛先アドレス

usernameとemailの使い分け

ユーザーを招待する場合、usernameもしくはemailのいずれか１つをクエリパラメータとして与えてください。usernameを指定する場合、DeployGateユーザの中から該当するユーザ名のユーザーがメンバーに追加されます。emailを指定する場合、もし対象のメールアドレスが既にDeployGateのユーザである場合はそのユーザーを追加し、DeployGateにまだサインアップしていないユーザの場合はサインアップの案内を含む招待状メールを送付します。招待状を受け取ったユーザはサインアップ完了後、自動的に招待されたグループのメンバーになります。

Suggest Edits

グループのメンバーを削除

グループに所属しているユーザーをメンバーから削除します

deletehttps://deploygate.com/api/organizations/organization_name/members/id

cURL

curl \
  -X DELETE
  -F 'token=xxx' \
  https://deploygate.com/api/organizations/_organization_name_/members/_user_name_or_email_

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
	"error": false,
	"message": "invitee was removed from sample-organization"
}

Path Params

organization_name

string

required

グループ名

id

string

required

削除する対象ユーザのユーザー名、もしくはメールアドレス

招待中のユーザの削除

DeployGateへのサインアップが完了していないユーザの招待を取り消す場合は、URLのidにメールアドレスを指定することで、対象ユーザーをメンバーから削除することができます。

Suggest Edits

チームのメンバー一覧を取得

グループ内のチームメンバーのユーザー情報一覧を取得します。

gethttps://deploygate.com/api/organizations/organization_name/teams/team_name/users

cURL

curl　"https://deploygate.com/api/organizations/_organization_name_/teams/_team_name_/users?token=xxx"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error": false,
  "users": [
    {
      "type": "User",
      "name": "foo",
      "icon_url": "https://secure.gravatar.com/avatar/foo",
      "url": "https://deploygate.com/users/foo"
    },
    {
      "type": "User",
      "name": "invitee@test.com",
      "icon_url": "https://secure.gravatar.com/avatar/default",
      "inviting": true,
      "url": "https://deploygate.com/users/invitee@test.com"
    }
  ]
}

Path Params

organization_name

string

required

グループ名

team_name

string

required

チーム名

Suggest Edits

チームにメンバーを追加

チームのメンバーにユーザーを追加します。

Suggest Edits

チームからメンバーを削除

チームに所属しているユーザーをチームから削除します

deletehttps://deploygate.com/api/organizations/organization_name/teams/team_name/users/id

cURL

curl \
  -X DELETE
  -F 'token=xxx' \
  https://deploygate.com/api/organizations/_organization_name_/teams/_team_name_/users/_user_namel_

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
	"error": false,
	"message": "invitee was removed from sample-team(sample-organization)"
}

Path Params

organization_name

string

required

グループ名

team_name

string

required

チーム名

id

string

required

削除する対象ユーザのユーザー名

Suggest Edits

エンタープライズAPIの利用に関する注意事項

エンタープライズのAPI Key

エンタープライズ関連APIを使用する場合、tokenパラメータにユーザーのAPI Keyに加えて、エンタープライズのAPI Keyを利用することができます。

エンタープライズのAPI Keyを使用することで、特定のユーザに紐付かない状態で操作を行うことができます。エンタープライズのAPI Keyによるアクセスを行う場合の権限は管理者となり、すべての操作を行うことができます。

Suggest Edits

エンタープライズのメンバー一覧を取得

エンタープライズに所属しているユーザー情報一覧を取得します。

Suggest Edits

エンタープライズにメンバーを追加

新しいユーザーをエンタープライズに追加します。

Suggest Edits

エンタープライズのメンバーを削除

エンタープライズに所属しているユーザーをメンバーから削除します

Suggest Edits

グループのメンバーの一覧を取得

グループに所属しているユーザー情報一覧を取得します。

gethttps://deploygate.com/api/enterprises/enterprise_name/organizations/organization_name/users

cURL

curl　"https://deploygate.com/api/enterprises/_enterprise_name_/organizations/_organization_name_/users?token=xxx"

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error":false,
  "users":[{
      "type": "User",
      "name": "foo",
      "icon_url": "https://secure.gravatar.com/avatar/foo",
      "url": "https://deploygate.com/users/foo"
    }]
}

Path Params

enterprise_name

string

required

エンタープライズ名

organization_name

string

required

グループ名

Suggest Edits

グループにメンバーを追加

新しいユーザーをグループに追加します。追加するユーザーはエンタープライズに所属している必要があります。

Suggest Edits

グループのメンバーを削除

グループに所属しているユーザーをメンバーから削除します

deletehttps://deploygate.com/api/enterprises/enterprise_name/organizations/organization_name/users/id

cURL

curl \
  -X DELETE
  -F 'token=xxx' \
  https://deploygate.com/api/enterprises/_enterprise_name_/organizations/_organization_name_/users/_user_name_

{{ results.statusCode[0] }} {{ results.statusCode[1] }}

Metadata

to examples

A binary file was returned

You couldn't be authenticated

Method

URL

Request Headers

{{ results.requestHeaders }}

Request Data

{{ results.data }}

Status

Response Headers

{{ results.responseHeaders }}

200 OK

{
  "error":false,
  "message":"invitee was removed from sample-organization(sample-enterprise)"
}

Path Params

enterprise_name

string

required

エンタープライズ名

organization_name

string

required

グループ名

id

string

required

削除する対象ユーザのユーザー名

制限事項について

Query Auth

Path Params

Body Params

Query Auth

Path Params

Body Params

Query Auth

Path Params

Query Auth

Path Params

Body Params

Query Auth

Path Params

Query Auth

Path Params

Body Params

Query Auth

Path Params

Query Auth

Path Params

Query Auth

Path Params

Body Params

Query Auth

Path Params

グループのAPI Key

Query Auth

Query Auth

Body Params

Query Auth

Path Params

Query Auth

Path Params

Body Params

Query Auth

Path Params

Query Auth

Path Params

招待中のユーザー

Query Auth

Path Params

Query Params

usernameとemailの使い分け

Query Auth

Path Params

招待中のユーザの削除

Query Auth

Path Params

Query Auth

Path Params

Query Params

Query Auth

Path Params

エンタープライズのAPI Key

Query Auth

Path Params

Query Auth

Path Params

Query Params

Query Auth

Path Params

Query Auth

Path Params

Query Auth

Path Params

Query Params

Query Auth

Path Params