組織の動作を定義する
Auth0でアプリケーションを表す場合には、アプリケーションが対応するべきユーザーの種類を指定することができます。個人による個人アカウントへのログインに対応するアプリケーションもあれば、組織のメンバーによる使用が目的のものもあります。それらの両方に対応するものもあります。これは組織の動作と呼ばれ、Auth0に接続するアプリケーションのそれぞれに設定することができます。
たとえば、アプリケーションには以下を設定することができます。
汎用のマーケティング用ランディングページに[ログイン]ボタンを提供して、組織を使わずに、ユーザーをAuth0のログインフローに送る。
B2B顧客のそれぞれに個別のURL(Acmeユーザーであれば
acme.yourcompany.com
など)があり、ユーザーが組織を使ってAuth0 にリダイレクトされ、AcmeのSSOの[ログイン]ボタンが表示される。
これらのシナリオに合わせて組織の動作を定義することができます。また、組織の動作として、アプリケーションで組織の提供を必須にして、ユーザーが誤って組織を使わないAuth0へ送られた場合、組織の名前を入力できるプロンプトが表示されるように定義することもできます。
組織の動作はAuth0 DashboardまたはManagement APIを使って定義できます。
Auth0 Dashboard
Auth0 Dashboardを使用して組織の動作を定義するには、以下を行います。
[Auth0 Dashboard]>[Applications(アプリケーション)]に移動して、組織を構成したいアプリケーションを選択します。
[Organizations(組織)]ビューを選択して、適切な設定を構成します。
フィールド 説明 APIマッピング ユーザーのタイプ どのカテゴリーのユーザーがアプリケーションにログインできるかを決定します。
オプションには以下が含まれます:- 個人:ユーザーは、個人のアカウントでサインアップでき、アプリケーションに直接ログインできます。個人のユーザーはOrganizationを使用してログインできません。
- ビジネスユーザー:ログインするためには、ユーザーはOrganizationのメンバーでなければなりません。選択した場合、Organizationを提供してユーザーを
/authorize
エンドポイントにリダイレクトするか、またはOrganizationのプロンプトのためにログインフローを設定する必要があります。 - 両方:ユーザーは、Organizationメンバーとしてログインするか、または個人のアカウントでサインアップできます。
__ユーザーのタイプ__のマッピング先 organization_usage
オプション:- __個人__のマッピング先
deny
- __ビジネスユーザー__のマッピング先
require
- __両方__のマッピング先
allow
ログインフロー アプリケーションにアクセスしたときにユーザーに表示する最初のログインプロンプトを決定します。ユーザーのタイプがビジネスユーザーまたは両方に設定されている場合のみ、このフィールドを構成できます。
オプションは次のとおりです:- 資格情報のプロンプト:ユーザーは最初にログインの資格情報を提供するように求められます。ログイン後、ユーザーはOrganizationを選択できます。
- Organizationのプロンプト:ユーザーは最初にOrganizationを選択するように求められます。その後、ログインするための資格情報を提供できます。ユーザーのタイプがビジネスユーザーに設定されている場合のみ、このオプションを使用できます。
- プロンプトなし:Auth0は、ユーザーに提供するログインプロンプトを規定していません。代わりに、あなたのアプリケーションが、適切なプロンプトを表示するために、Auth0に必要なパラメーターを送信する責任を負います。
ログインフロー のマッピング先 organization_require_behavior
オプション:- __資格情報のプロンプト__のマッピング先
post_login_prompt
- __Organizationのプロンプト__のマッピング先
pre_login_prompt
- __プロンプトなし__のマッピング先
no_prompt
[Save Changes(変更の保存)]を選択します。
Mangement API
クライアント更新エンドポイントにPATCH
呼び出しを行います。client_id
、mgmt_api_access_token
、organization_usage
、およびorganization_require_behavior
のプレースホルダーをそれぞれクライアントID、Management APIのアクセストークン、組織の使用オプション、組織の動作オプションに置き換えます。
curl --request PATCH \
--url 'https://{yourDomain}/api/v2/clients/CLIENT_ID' \
--header 'authorization: Bearer MGMT_API_ACCESS_TOKEN' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data '{ "organization_usage": "ORG_USAGE", "organization_require_behavior": "ORG_REQUIRE_BEHAVIOR" }'
Was this helpful?
var client = new RestClient("https://{yourDomain}/api/v2/clients/CLIENT_ID");
var request = new RestRequest(Method.PATCH);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "Bearer MGMT_API_ACCESS_TOKEN");
request.AddHeader("cache-control", "no-cache");
request.AddParameter("application/json", "{ \"organization_usage\": \"ORG_USAGE\", \"organization_require_behavior\": \"ORG_REQUIRE_BEHAVIOR\" }", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Was this helpful?
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://{yourDomain}/api/v2/clients/CLIENT_ID"
payload := strings.NewReader("{ \"organization_usage\": \"ORG_USAGE\", \"organization_require_behavior\": \"ORG_REQUIRE_BEHAVIOR\" }")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
req.Header.Add("authorization", "Bearer MGMT_API_ACCESS_TOKEN")
req.Header.Add("cache-control", "no-cache")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
Was this helpful?
HttpResponse<String> response = Unirest.patch("https://{yourDomain}/api/v2/clients/CLIENT_ID")
.header("content-type", "application/json")
.header("authorization", "Bearer MGMT_API_ACCESS_TOKEN")
.header("cache-control", "no-cache")
.body("{ \"organization_usage\": \"ORG_USAGE\", \"organization_require_behavior\": \"ORG_REQUIRE_BEHAVIOR\" }")
.asString();
Was this helpful?
var axios = require("axios").default;
var options = {
method: 'PATCH',
url: 'https://{yourDomain}/api/v2/clients/CLIENT_ID',
headers: {
'content-type': 'application/json',
authorization: 'Bearer MGMT_API_ACCESS_TOKEN',
'cache-control': 'no-cache'
},
data: {
organization_usage: 'ORG_USAGE',
organization_require_behavior: 'ORG_REQUIRE_BEHAVIOR'
}
};
axios.request(options).then(function (response) {
console.log(response.data);
}).catch(function (error) {
console.error(error);
});
Was this helpful?
#import <Foundation/Foundation.h>
NSDictionary *headers = @{ @"content-type": @"application/json",
@"authorization": @"Bearer MGMT_API_ACCESS_TOKEN",
@"cache-control": @"no-cache" };
NSDictionary *parameters = @{ @"organization_usage": @"ORG_USAGE",
@"organization_require_behavior": @"ORG_REQUIRE_BEHAVIOR" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://{yourDomain}/api/v2/clients/CLIENT_ID"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
Was this helpful?
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{yourDomain}/api/v2/clients/CLIENT_ID",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "{ \"organization_usage\": \"ORG_USAGE\", \"organization_require_behavior\": \"ORG_REQUIRE_BEHAVIOR\" }",
CURLOPT_HTTPHEADER => [
"authorization: Bearer MGMT_API_ACCESS_TOKEN",
"cache-control: no-cache",
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Was this helpful?
import http.client
conn = http.client.HTTPSConnection("")
payload = "{ \"organization_usage\": \"ORG_USAGE\", \"organization_require_behavior\": \"ORG_REQUIRE_BEHAVIOR\" }"
headers = {
'content-type': "application/json",
'authorization': "Bearer MGMT_API_ACCESS_TOKEN",
'cache-control': "no-cache"
}
conn.request("PATCH", "/{yourDomain}/api/v2/clients/CLIENT_ID", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Was this helpful?
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://{yourDomain}/api/v2/clients/CLIENT_ID")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'Bearer MGMT_API_ACCESS_TOKEN'
request["cache-control"] = 'no-cache'
request.body = "{ \"organization_usage\": \"ORG_USAGE\", \"organization_require_behavior\": \"ORG_REQUIRE_BEHAVIOR\" }"
response = http.request(request)
puts response.read_body
Was this helpful?
import Foundation
let headers = [
"content-type": "application/json",
"authorization": "Bearer MGMT_API_ACCESS_TOKEN",
"cache-control": "no-cache"
]
let parameters = [
"organization_usage": "ORG_USAGE",
"organization_require_behavior": "ORG_REQUIRE_BEHAVIOR"
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://{yourDomain}/api/v2/clients/CLIENT_ID")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
Was this helpful?
値 | 説明 |
---|---|
CLIENT_ID |
Organizationの動作を追加したいアプリケーションのIDです。 |
MGMT_API_ACCESS_TOKEN |
update:clients スコープのあるManagement APIのアクセストークンです。 |
ORGANIZATION_USAGE |
ユーザーがOrganizationにログインすることに、アプリケーションが対応するか決定します。オプションには以下が含まれます。
|
ORGANIZATION_REQUIRE_BEHAVIOR |
アプリケーションへのアクセスでユーザーに提供するログインフローを決定します。organization_usage がrequire またはallow に設定されている場合にのみ適用されます。オプションには以下が含まれます。
|
応答ステータスコード
可能性のある応答ステータスコードは以下のとおりです。
ステータスコード | エラーコード | メッセージ | 原因 |
---|---|---|---|
200 |
Client successfully updated.(クライアントが正常に更新されました。) | ||
400 |
invalid_uri |
Invalid request URI.(要求URIが無効です。)メッセージは原因によって異なります。 | パスが有効ではありません。 |
400 |
invalid_body |
Invalid request body.(要求ボディーが無効です。)メッセージは原因によって異なります。 | 要求ペイロードが有効ではありません。 |
401 |
Invalid token.(無効なトークンです。) | ||
401 |
Client is not global.(クライアントがグローバルではありません。) | ||
401 |
Invalid signature received for JSON Web Token validation.(JSON Web Tokenの検証に無効な署名を受け取りました。) | ||
403 |
insufficient_scope |
Insufficient scope; expected any of: update:clients .(スコープが不足しています。update:clients が必要です。) |
渡されたベアラートークンのスコープでは許可されないフィールドの読み込みや書き出しが試行されました。 |
403 |
insufficient_scope |
Some fields cannot be updated with the permissions granted by the bearer token scopes.(一部のフィールドは、ベアラートークンのスコープで付加された権限では更新できません。)メッセージはフィールドやスコープによって異なります。 | 渡されたベアラートークンのスコープでは許可されないフィールドの読み込みや書き出しが試行されました。 |
403 |
operation_not_supported |
The account is not allowed to perform this operation.(アカウントには、この操作の実行が許可されていません。) | アカウントにこの操作の実行が許可されていません。 |
404 |
inexistent_client |
Client not found.(クライアントが見つかりません。) | 存在しないリソースです。指定されたアプリケーションは存在しません。 |
429 |
Too many requests.Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.(要求が多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetヘッダーを確認してください。) |