keycloak admin client

• การแนะนำ
• วิธีใช้
• การปรับแต่ง
• API ที่รองรับ
  • การตรวจจับการโจมตี
  • การจัดการการรับรองความถูกต้อง
  • ใบรับรองคุณสมบัติลูกค้า
  • การเข้าถึงเริ่มต้นของไคลเอ็นต์
  • นโยบายการลงทะเบียนลูกค้า
  • การแมปบทบาทลูกค้า
  • ขอบเขตลูกค้า
  • ลูกค้า
  • ส่วนประกอบ
  • กลุ่ม
  • ผู้ให้บริการข้อมูลประจำตัว
  • สำคัญ
  • ผู้ทำแผนที่โปรโตคอล
  • ผู้ดูแลระบบอาณาจักร
  • ผู้ทำแผนที่บทบาท
  • บทบาท
  • บทบาท (ตาม ID)
  • การแมปขอบเขต
  • ผู้ให้บริการจัดเก็บข้อมูลผู้ใช้
  • ผู้ใช้
  • ราก

การแนะนำ

นี่คือไคลเอนต์ php เพื่อเชื่อมต่อกับ API ส่วนที่เหลือของผู้ดูแลระบบ keycloak โดยไม่ต้องปวดหัว

คุณสมบัติ:

1. ใช้งานง่าย
2. ไม่จำเป็นต้องรับโทเค็นหรือสร้างมันขึ้นมา - ไคลเอนต์ได้รับการจัดการแล้ว
3. ไม่จำเป็นต้องระบุ URL ใด ๆ นอกเหนือจาก uri พื้นฐาน
4. ไม่มีการเข้ารหัส/ถอดรหัสสำหรับ json เพียงข้อมูลตามที่คุณคาดหวัง

ทำงานร่วมกับผู้ดูแลระบบ REST API ของ Keycloak 7.0+

https://www.keycloak.org/documentation -> "Administration REST API"

วิธีใช้

1. สร้างลูกค้าใหม่

 $ client = Keycloak  Admin KeycloakClient:: factory ([
    ' realm ' => ' master ' ,
    ' username ' => ' admin ' ,
    ' password ' => ' 1234 ' ,
    ' client_id ' => ' admin-cli ' ,
    ' baseUri ' => ' http://127.0.0.1:8180 ' ,
]);

ตั้งแต่เวอร์ชัน 0.30 หาก URL ฐาน Keycloak ของคุณขึ้นต้นด้วย auth/ ให้เพิ่มลงใน baseUri (เช่น http://127.0.0.1:8180/auth/) URL ฐานสำหรับ Keycloak เวอร์ชัน 7 ถึง 16 มี auth/ อย่างเป็นระบบ สำหรับ Keycloak 17+ ขึ้นอยู่กับการตั้งค่าของคุณ

2. ใช้มัน

 $ client -> getUsers ();

//Result
// Array of users
/*
[
     [
       "id" => "39839a9b-de08-4d2c-b91a-a6ce2595b1f3",
       "createdTimestamp" => 1571663375749,
       "username" => "admin",
       "enabled" => true,
       "totp" => false,
       "emailVerified" => false,
       "disableableCredentialTypes" => [
         "password",
       ],
       "requiredActions" => [],
       "notBefore" => 0,
       "access" => [
         "manageGroupMembership" => true,
         "view" => true,
         "mapRoles" => true,
         "impersonate" => true,
         "manage" => true,
       ],
     ],
   ]
*/

$ client -> createUser ([
    ' username ' => ' test ' ,
    ' email ' => ' [email protected] ' ,
    ' enabled ' => true ,
    ' credentials ' => [
        [
            ' type ' => ' password ' ,
            ' value ' => ' 1234 ' ,
        ],
    ],
]);

การปรับแต่ง

ข้อมูลรับรองที่ได้รับการสนับสนุน

เป็นไปได้ที่จะเปลี่ยนประเภทของข้อมูลประจำตัวที่ใช้ในการตรวจสอบสิทธิ์โดยการเปลี่ยนการกำหนดค่าของไคลเอ็นต์ keycloak

ในปัจจุบัน รองรับข้อมูลรับรองต่อไปนี้

• ข้อมูลรับรองรหัสผ่านที่ใช้เป็นค่าเริ่มต้น
  • เพื่อตรวจสอบสิทธิ์กับบัญชีผู้ใช้

   $ client = Keycloak  Admin KeycloakClient:: factory ([
      ...
      ' grant_type ' => ' password ' ,
      ' username ' => ' admin ' ,
      ' password ' => ' 1234 ' ,
  ]);

• ข้อมูลรับรองลูกค้า
  • เพื่อตรวจสอบสิทธิ์กับบัญชีบริการลูกค้า

   $ client = Keycloak  Admin KeycloakClient:: factory ([
      ...
      ' grant_type ' => ' client_credentials ' ,
      ' client_id ' => ' admin-cli ' ,
      ' client_secret ' => ' 84ab3d98-a0c3-44c7-b532-306f222ce1ff ' ,
  ]);

การฉีดมิดเดิลแวร์

เป็นไปได้ที่จะฉีดมิดเดิลแวร์ไคลเอนต์ Guzzle ในการกำหนดค่าไคลเอนต์ keycloak โดยใช้คำสำคัญ middlewares

ตัวอย่างเช่น:

 use GuzzleHttp  Middleware ;
use Psr  Http  Message  RequestInterface ;

$ client = Keycloak  Admin KeycloakClient:: factory ([
    ...
    ' middlewares ' => [
        // throws exceptions when request fails
        Middleware:: httpErrors (),
        // other custom middlewares
        Middleware:: mapRequest ( function ( RequestInterface $ request ) {
            return $ request ;
        }),
    ],
]);

การเปลี่ยนวิธีการบันทึกและจัดเก็บโทเค็น

ตามค่าเริ่มต้น โทเค็นจะถูกบันทึกขณะรันไทม์ ซึ่งหมายความว่าโทเค็นก่อนหน้าจะไม่ถูกใช้เมื่อสร้างไคลเอนต์ใหม่

คุณสามารถกำหนดวิธีจัดเก็บโทเค็นในการกำหนดค่าไคลเอ็นต์ได้โดยใช้ TokenStorage ของคุณเอง ซึ่งเป็นอินเทอร์เฟซที่อธิบายวิธีจัดเก็บและดึงโทเค็น

 class CustomTokenStorage implements TokenStorage 
{
    public function getToken () 
    {
        // TODO
    }
    
    public function saveToken ( array $ token )
    {
        // TODO
    }
}

$ client = Keycloak  Admin KeycloakClient:: factory ([
    ...
    ' token_storage ' => new CustomTokenStorage (),
]);

จุดสิ้นสุด Keycloak แบบกำหนดเอง

เป็นไปได้ที่จะฉีด Guzzle Service Operations ในการกำหนดค่าไคลเอนต์ keycloak โดยใช้คีย์เวิร์ด custom_operations วิธีนี้ทำให้คุณสามารถขยายจุดสิ้นสุดที่รองรับในตัวด้วยแบบกำหนดเองได้

 $ client = KeycloakClient:: factory ([
...
    ' custom_operations ' => [
        ' getUsersByAttribute ' => [
            ' uri ' => ' /auth/realms/{realm}/userapi-rest/users/search-by-attr ' ,
            ' description ' => ' Get users by attribute Returns a list of users, filtered according to query parameters ' ,
            ' httpMethod ' => ' GET ' ,
            ' parameters ' => [
                ' realm ' => [
                    ' location ' => ' uri ' ,
                    ' description ' => ' The Realm name ' ,
                    ' type ' => ' string ' ,
                    ' required ' => true ,
                ],
                ' attr ' => [
                    ' location ' => ' query ' ,
                    ' type ' => ' string ' ,
                    ' required ' => true ,
                ],
                ' value ' => [
                    ' location ' => ' query ' ,
                    ' type ' => ' string ' ,
                    ' required ' => true ,
                ],
            ],
        ],
    ]
]);

API ที่รองรับ

การตรวจจับการโจมตี

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
ล้างความล้มเหลวในการเข้าสู่ระบบของผู้ใช้สำหรับผู้ใช้ทั้งหมด การดำเนินการนี้สามารถปล่อยผู้ใช้ที่ถูกปิดใช้งานชั่วคราวได้	clearAllLoginFailures
รับสถานะของชื่อผู้ใช้ในการตรวจจับกำลังดุร้าย	getBruteForceUserStatus
ล้างความล้มเหลวในการเข้าสู่ระบบของผู้ใช้ การดำเนินการนี้สามารถปล่อยผู้ใช้ที่ถูกปิดใช้งานชั่วคราวได้	clearUserLoginFailures

การจัดการการรับรองความถูกต้อง

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับผู้ให้บริการตรวจสอบความถูกต้อง ส่งกลับรายชื่อผู้ให้บริการตรวจสอบความถูกต้อง	getAuthenticatorProviders
รับผู้ให้บริการตัวตรวจสอบความถูกต้องไคลเอนต์ ส่งคืนรายชื่อผู้ให้บริการตัวตรวจสอบความถูกต้องไคลเอนต์	getClientAuthenticatorProviders
รับคำอธิบายการกำหนดค่าของผู้ให้บริการตรวจสอบสิทธิ์	getAuthenticatorConfigInfo
รับการกำหนดค่าตัวตรวจสอบความถูกต้อง	getAuthenticatorConfig
อัปเดตการกำหนดค่าตัวตรวจสอบสิทธิ์	อัพเดต AuthenticatorConfig
ลบการกำหนดค่าตัวตรวจสอบความถูกต้อง	ลบ AuthenticatorConfig
เพิ่มการดำเนินการรับรองความถูกต้องใหม่	createAuthenticationExecution
รับการดำเนินการครั้งเดียว	getAuthenticationExecution
ลบการดำเนินการ	ลบAuthenticationExecution
อัปเดตการดำเนินการด้วยการกำหนดค่าใหม่	updateAuthenticationExecution
ลำดับความสำคัญของการดำเนินการที่ต่ำกว่า	AuthenticationExecutionPriority ที่ต่ำกว่า
เพิ่มลำดับความสำคัญของการดำเนินการ	RaiseAuthenticationExecutionPriority
สร้างขั้นตอนการรับรองความถูกต้องใหม่	createAuthenticationFlow
รับโฟลว์การรับรองความถูกต้อง ส่งกลับรายการโฟลว์การรับรองความถูกต้อง	getAuthenticationFlows
คัดลอกโฟลว์การรับรองความถูกต้องที่มีอยู่ภายใต้ชื่อใหม่ ชื่อใหม่ถูกกำหนดเป็นแอตทริบิวต์ 'newName' ของวัตถุ JSON ที่ส่งผ่าน	คัดลอกAuthenticationFlow
รับการดำเนินการรับรองความถูกต้องสำหรับโฟลว์	getAuthenticationFlowExecutions
อัปเดตการดำเนินการตรวจสอบสิทธิ์สำหรับโฟลว์	updateAuthenticationFlowExecutions
เพิ่มการดำเนินการรับรองความถูกต้องใหม่ให้กับโฟลว์	createAuthenticationFlowExecution
เพิ่มโฟลว์ใหม่ด้วยการดำเนินการใหม่ให้กับโฟลว์ที่มีอยู่	addAuthenticationFlowExecution
รับโฟลว์การรับรองความถูกต้องสำหรับ id	getAuthenticationFlow
อัปเดตขั้นตอนการตรวจสอบสิทธิ์สำหรับ ID	updateAuthenticationFlow
ลบขั้นตอนการรับรองความถูกต้อง	ลบ AuthenticationFlow
รับผู้ให้บริการดำเนินการแบบฟอร์ม ส่งกลับรายชื่อผู้ให้บริการดำเนินการแบบฟอร์ม	getFormActionProviders
รับผู้ให้บริการแบบฟอร์ม ส่งกลับรายชื่อผู้ให้บริการแบบฟอร์ม	getFormProviders
รับคำอธิบายการกำหนดค่าสำหรับไคลเอนต์ทั้งหมด	getClientsConfigDescriptions
ลงทะเบียนการดำเนินการที่จำเป็นใหม่	createRequiredAction
รับการดำเนินการที่จำเป็น ส่งกลับรายการการดำเนินการที่จำเป็น	getRequiredActions
รับการดำเนินการที่จำเป็นสำหรับนามแฝง	getAliasRequiredAction
อัปเดตการดำเนินการที่จำเป็น	updateRequiredAction
ลบการดำเนินการที่จำเป็น	ลบการดำเนินการที่จำเป็น
ลดลำดับความสำคัญของการดำเนินการที่จำเป็น	ต่ำกว่า RequiredActionPriority
เพิ่มลำดับความสำคัญของการดำเนินการที่จำเป็น	เพิ่ม RequiredActionPriority
รับการดำเนินการที่จำเป็นที่ไม่ได้ลงทะเบียน ส่งคืนรายการการดำเนินการที่จำเป็นที่ไม่ได้ลงทะเบียน	getUnregisteredRequiredActions

ใบรับรองคุณสมบัติลูกค้า

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับข้อมูลสำคัญ (ลองใช้ attr = "jwt.credential")	รับ ClientKeyInfo
รับไฟล์ที่เก็บคีย์สำหรับไคลเอ็นต์ ซึ่งมีคีย์ส่วนตัวและใบรับรองพับลิก (หมายเหตุ: เขียนเนื้อหาตอบกลับลงในไฟล์)	getClientKeyStore
สร้างใบรับรองใหม่ด้วยคู่คีย์ใหม่	สร้างใบรับรองไคลเอนต์
สร้างคู่คีย์และใบรับรองใหม่ และรับไฟล์คีย์ส่วนตัว สร้างคู่คีย์และใบรับรอง และให้บริการคีย์ส่วนตัวในรูปแบบที่เก็บคีย์ที่ระบุ	GenerateDownloadClientCertificate
อัปโหลดใบรับรองและรหัสส่วนตัวในที่สุด	uploadClientCertificateAndPrivateKey
อัปโหลดเฉพาะใบรับรอง ไม่ใช่รหัสส่วนตัว	อัพโหลดใบรับรองไคลเอ็นต์เท่านั้น

การเข้าถึงเริ่มต้นของไคลเอ็นต์

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างโทเค็นการเข้าถึงเริ่มต้นใหม่	createClientInitialAccessToken
GET /{realm}/clients-initial-access	getClientInitialAccessTokens
ลบ /{realm}/clients-initial-access/{id}	ลบ ClientInitialAccessToken

นโยบายการลงทะเบียนลูกค้า

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
พาธหลักสำหรับการเรียกข้อมูลผู้ให้บริการที่มีการเติม configProperties อย่างถูกต้อง	getClientRegistrationPolicyProviders

การแมปบทบาทลูกค้า

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
เพิ่มบทบาทระดับลูกค้าในการแมปบทบาทของกลุ่ม	addGroupClientRoleMappings
รับการแมปบทบาทระดับไคลเอนต์สำหรับกลุ่มและแอป	getGroupClientRoleMappings
ลบบทบาทระดับไคลเอ็นต์ออกจากการแมปบทบาทกลุ่ม	ลบ GroupClientRoleMappings
รับบทบาทระดับไคลเอ็นต์ที่มีอยู่ซึ่งสามารถแม็ปกับกลุ่มได้	getAvailableGroupClientRoleMappings
รับการแมปบทบาทระดับไคลเอ็นต์ที่มีประสิทธิภาพ ซึ่งจะเป็นการเรียกซ้ำบทบาทแบบผสมสำหรับกลุ่ม	getGroupClientRoleMappingsWithComposite
เพิ่มบทบาทระดับไคลเอ็นต์ในการแมปบทบาทของผู้ใช้	addUserClientRoleMappings
รับการแมปบทบาทระดับไคลเอนต์สำหรับผู้ใช้และแอป	getUserClientRoleMappings
ลบบทบาทระดับไคลเอ็นต์ออกจากการแมปบทบาทของผู้ใช้	ลบUserClientRoleMappings
รับบทบาทระดับไคลเอ็นต์ที่มีอยู่ซึ่งสามารถแม็ปกับผู้ใช้ได้	getAvailableUserClientRoleMappings
รับการแมปบทบาทระดับไคลเอ็นต์ที่มีประสิทธิภาพ ซึ่งจะเรียกซ้ำบทบาทแบบผสมสำหรับผู้ใช้	getUserClientRoleMappingsWithComposite

ขอบเขตลูกค้า

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างขอบเขตไคลเอ็นต์ใหม่ ชื่อของขอบเขตไคลเอ็นต์จะต้องไม่ซ้ำกัน!	createClientScope
รับขอบเขตไคลเอ็นต์ที่เป็นของขอบเขต ส่งคืนรายการขอบเขตไคลเอ็นต์ที่เป็นของขอบเขต	getClientScopes
รับการแสดงขอบเขตของลูกค้า	getClientScope
อัปเดตขอบเขตไคลเอ็นต์	อัพเดต ClientScope
ลบขอบเขตไคลเอ็นต์	ลบ ClientScope

ลูกค้า

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างไคลเอนต์ใหม่ client_id ของลูกค้าจะต้องไม่ซ้ำกัน!	createClient
รับลูกค้าที่อยู่ในขอบเขต ส่งคืนรายชื่อลูกค้าที่อยู่ในขอบเขต	รับลูกค้า
รับตัวแทนลูกค้า	รับไคลเอนต์
อัปเดตไคลเอนต์	updateClient
ลบไคลเอ็นต์	ลบไคลเอนต์
สร้างความลับใหม่ให้กับลูกค้า	สร้าง ClientSecret
รับความลับของลูกค้า	getClientSecret
รับขอบเขตไคลเอ็นต์เริ่มต้น	getClientDefaultScopes
ตั้งค่าขอบเขตไคลเอ็นต์เป็นขอบเขตเริ่มต้น	setClientScopeAsDefault
ลบขอบเขตไคลเอ็นต์ออกจากขอบเขตเริ่มต้น	ลบ ClientScopeAsDefault
สร้าง JSON ด้วยเพย์โหลดของโทเค็นการเข้าถึงตัวอย่าง	getClientExampleAccessToken
รายการส่งคืนของผู้แมปโปรโตคอลทั้งหมด ซึ่งจะใช้เมื่อสร้างโทเค็นที่ออกให้สำหรับลูกค้ารายใดรายหนึ่ง	getClientProtocolMappers
รับการแมปขอบเขตที่มีประสิทธิภาพของบทบาททั้งหมดของคอนเทนเนอร์บทบาทเฉพาะ ซึ่งไคลเอ็นต์นี้ได้รับอนุญาตให้ defacto มีใน accessToken ที่ออกให้เขา	getClientAllowedRoleMappingsInContainer
รับบทบาทซึ่งลูกค้ารายนี้ไม่มีขอบเขตและไม่สามารถมีได้ใน accessToken ที่ออกให้เขา	getClientNotAllowedRoleMappingsInContainer
การสร้างคอนฟิกูเรชันอะแด็ปเตอร์ไคลเอ็นต์ใช้หนึ่งในสิ่งเหล่านี้ (keycloak-oidc-keycloak-json, keycloak-oidc-jboss-subsystem-cli, keycloak-oidc-jboss-subsystem, keycloak-saml, keycloak-saml-subsystem-cli, keycloak-saml -ระบบย่อย)	getClientInstallationConfiguration
ส่งคืนวัตถุที่ระบุว่าสิทธิ์การอนุญาตไคลเอ็นต์เริ่มต้นแล้วหรือไม่และมีการอ้างอิง	getClientAuthorizationPermissionsStatus
อัปเดตการเริ่มต้นสิทธิ์การอนุญาตไคลเอ็นต์และการอ้างอิง	updateClientAuthorizationPermissionsStatus
ลงทะเบียนโหนดคลัสเตอร์กับไคลเอนต์ ลงทะเบียนโหนดคลัสเตอร์ด้วยตนเองไปยังไคลเอนต์นี้ - โดยปกติแล้วไม่จำเป็นต้องเรียกสิ่งนี้โดยตรงเนื่องจากอะแดปเตอร์ควรจัดการโดยส่งคำขอลงทะเบียนไปที่ Keycloak	ลงทะเบียนClientClusterNode
ยกเลิกการลงทะเบียนโหนดคลัสเตอร์จากไคลเอ็นต์	ยกเลิกการลงทะเบียนClientClusterNode
รับจำนวนเซสชันออฟไลน์ของแอปพลิเคชัน ส่งคืนเซสชันผู้ใช้ออฟไลน์จำนวนหนึ่งที่เชื่อมโยงกับไคลเอนต์นี้ { "count": number }	getClientOfflineSessionsCount
รับเซสชันออฟไลน์สำหรับไคลเอนต์ ส่งคืนรายการเซสชันผู้ใช้ออฟไลน์ที่เชื่อมโยงกับไคลเอนต์นี้	getClientOfflineSessions
รับขอบเขตไคลเอ็นต์เพิ่มเติม	getClientOptionalScopes
กำหนดขอบเขตเพิ่มเติมของลูกค้า	มอบหมาย ClientOptionalScope
ลบการกำหนดขอบเขตเพิ่มเติมของไคลเอนต์	ยกเลิกการมอบหมาย ClientOptionalScope
พุชนโยบายการเพิกถอนของลูกค้าไปยัง URL ของผู้ดูแลระบบ หากไคลเอนต์มี URL ของผู้ดูแลระบบ ให้พุชนโยบายการเพิกถอนไปที่นั้น	pushClientRevocationPolicy
สร้างโทเค็นการเข้าถึงการลงทะเบียนใหม่สำหรับลูกค้า	GenerateClientRegistrationToken
รับผู้ใช้เฉพาะสำหรับบัญชีบริการ	getServiceAccountDedicatedUser
รับจำนวนเซสชันของแอปพลิเคชัน ส่งคืนเซสชันผู้ใช้จำนวนหนึ่งที่เกี่ยวข้องกับไคลเอนต์นี้ { "count": number }	getClientSessionsCount
ทดสอบว่าโหนดคลัสเตอร์ที่ลงทะเบียนไว้พร้อมใช้งานหรือไม่ ทดสอบความพร้อมใช้งานโดยส่งคำขอ 'ping' ไปยังโหนดคลัสเตอร์ทั้งหมด	testClientNodes ความพร้อมใช้งาน
รับเซสชันผู้ใช้สำหรับไคลเอนต์ ส่งคืนรายการเซสชันผู้ใช้ที่เกี่ยวข้องกับไคลเอนต์นี้	getClientSessions

ส่วนประกอบ

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างส่วนประกอบใหม่	สร้างส่วนประกอบ
รับส่วนประกอบ	รับส่วนประกอบ
รับส่วนประกอบ	รับส่วนประกอบ
อัปเดตส่วนประกอบ	อัปเดตส่วนประกอบ
ลบส่วนประกอบ	ลบส่วนประกอบ
รายการประเภทส่วนประกอบย่อยที่พร้อมใช้งานเพื่อกำหนดค่าสำหรับส่วนประกอบหลักเฉพาะ	getComponentSubTypes

กลุ่ม

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างหรือเพิ่มกลุ่มขอบเขตระดับบนสุดหรือสร้างลูก	createGroup
รับลำดับชั้นของกลุ่ม	getGroups
ส่งกลับจำนวนกลุ่ม	getGroupsCount
รับกลุ่ม	getGroup
รับเด็กกลุ่ม (กลุ่มย่อย)	getGroupChildren
อัปเดตกลุ่ม ละเว้นกลุ่มย่อย	อัปเดตกลุ่ม
ลบกลุ่ม	ลบกลุ่ม
ตั้งค่าหรือสร้างลูก	createChildGroup
ส่งคืนวัตถุที่ระบุว่าสิทธิ์การอนุญาตไคลเอ็นต์เริ่มต้นแล้วหรือไม่และมีการอ้างอิง	รับสิทธิ์การจัดการกลุ่ม
ส่งคืนวัตถุที่ระบุว่าสิทธิ์การอนุญาตไคลเอ็นต์เริ่มต้นแล้วหรือไม่และมีการอ้างอิง	อัพเดตสิทธิ์การจัดการกลุ่ม
รับผู้ใช้ ส่งคืนรายชื่อผู้ใช้ กรองตามพารามิเตอร์การสืบค้น	getGroupMembers

ผู้ให้บริการข้อมูลประจำตัว

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
นำเข้าผู้ให้บริการข้อมูลประจำตัวจากไฟล์ JSON ที่อัปโหลด	importIdentityProvider
สร้างผู้ให้บริการข้อมูลประจำตัวใหม่	createIdentityProvider
รับผู้ให้บริการข้อมูลประจำตัว	getIdentityProviders
รับผู้ให้บริการข้อมูลประจำตัว	getIdentityProvider
อัปเดตผู้ให้บริการข้อมูลประจำตัว	อัพเดต IdentityProvider
ลบผู้ให้บริการข้อมูลประจำตัว	ลบ IdentityProvider
ส่งออกการกำหนดค่านายหน้าสาธารณะสำหรับผู้ให้บริการข้อมูลประจำตัว	ส่งออก IdentityProviderBrokerConfig
ส่งคืนวัตถุที่ระบุว่าสิทธิ์การอนุญาตไคลเอ็นต์เริ่มต้นแล้วหรือไม่และมีการอ้างอิง	getIdentityProviderManagement สิทธิ์
ส่งคืนวัตถุที่ระบุว่าสิทธิ์การอนุญาตไคลเอ็นต์เริ่มต้นแล้วหรือไม่และมีการอ้างอิง	อัพเดต IdentityProviderManagementPermissions
รับประเภทผู้ทำแผนที่สำหรับผู้ให้บริการข้อมูลประจำตัว (Keycloak ให้รายงานข้อยกเว้น)	getIdentityProviderMapperTypes
เพิ่มผู้ทำแผนที่ให้กับผู้ให้บริการข้อมูลประจำตัว	createIdentityProviderMapper
รับผู้ทำแผนที่สำหรับผู้ให้บริการข้อมูลระบุตัวตน	getIdentityProviderMappers
รับ mapper ด้วย id สำหรับผู้ให้บริการข้อมูลประจำตัว	getIdentityProviderMapper
อัปเดตผู้ทำแผนที่สำหรับผู้ให้บริการข้อมูลประจำตัว (ไม่ทำงานด้วยเหตุผลบางประการทำให้มีข้อยกเว้นตัวชี้ Null)	อัพเดต IdentityProviderMapper
ลบผู้ทำแผนที่สำหรับผู้ให้บริการข้อมูลประจำตัว	ลบ IdentityProviderMapper
รับผู้ให้บริการข้อมูลประจำตัว	getIdentityProviderById

สำคัญ

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับกุญแจอาณาจักร	รับ RealmKeys

ผู้ทำแผนที่โปรโตคอล

หมายเหตุ: รหัสจะถูกส่งเป็น clientScopeId หรือ clientId และ mapperId ทุกอย่างที่เหลือเป็นเพียงเอกสารประกอบของ keycloak

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างผู้ทำแผนที่หลายราย	createClientScopeProtocolMappers
สร้างผู้ทำแผนที่	createClientScopeProtocolMapper
รับคนทำแผนที่	getClientScopeProtocolMappers
รับผู้ทำแผนที่ด้วยรหัส	getClientScopeProtocolMapperById
อัปเดตผู้ทำแผนที่	อัพเดต ClientScopeProtocolMapper
ลบตัวทำแผนที่	ลบClientScopeProtocolMapper
รับผู้ทำแผนที่ตามชื่อสำหรับโปรโตคอลเฉพาะ	getClientScopeProtocolMappersByProtocolName
สร้างผู้ทำแผนที่หลายราย	createClientProtocolMappers
สร้างผู้ทำแผนที่	createClientProtocolMapper
รับคนทำแผนที่	getClientProtocolMappers
รับผู้ทำแผนที่ด้วยรหัส	getClientProtocolMapperById
อัปเดตผู้ทำแผนที่	updateClientProtocolMapper
ลบตัวทำแผนที่	ลบClientProtocolMapper
รับผู้ทำแผนที่ตามชื่อสำหรับโปรโตคอลเฉพาะ	getClientProtocolMappersByProtocolName

ผู้ดูแลระบบอาณาจักร

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับอาณาจักรที่สามารถเข้าถึงได้ ส่งคืนรายการอาณาจักรที่สามารถเข้าถึงได้ รายการจะถูกกรองตามขอบเขตที่ผู้เรียกได้รับอนุญาตให้ดู	รับอาณาจักร
นำเข้าขอบเขต นำเข้าขอบเขตจากการนำเสนอแบบเต็มของขอบเขตนั้น	importRealm
รับการเป็นตัวแทนระดับบนสุดของขอบเขต โดยจะไม่รวมข้อมูลที่ซ้อนกัน เช่น การเป็นตัวแทนผู้ใช้และลูกค้า	รับอาณาจักร
อัปเดตข้อมูลระดับบนสุดของขอบเขต ข้อมูลผู้ใช้ บทบาท หรือลูกค้าใดๆ ในการเป็นตัวแทนจะถูกละเว้น	อัปเดตอาณาจักร
ลบอาณาจักร	ลบอาณาจักร
รับกิจกรรมของผู้ดูแลระบบ ส่งคืนกิจกรรมของผู้ดูแลระบบทั้งหมด หรือกรองเหตุการณ์ตามพารามิเตอร์การสืบค้น URL ที่แสดงไว้ที่นี่	getAdminEvents
ลบกิจกรรมผู้ดูแลระบบทั้งหมด	ลบกิจกรรมผู้ดูแลระบบ
ล้างแคชของกุญแจสาธารณะภายนอก (กุญแจสาธารณะของลูกค้าหรือผู้ให้บริการข้อมูลประจำตัว)	clearExternalPublicKeysCache
ล้างแคชขอบเขต	ล้าง RealmCache
ล้างแคชของผู้ใช้	ล้าง UserCache
เส้นทางหลักสำหรับการนำเข้าไคลเอ็นต์ภายใต้ขอบเขตนี้	importClient
รับสถิติเซสชันไคลเอ็นต์ ส่งคืนแผนที่ JSON	getClientsSessionStats
GET /{realm}/credential-registrators	getCredentialRegistrators
รับขอบเขตไคลเอ็นต์เริ่มต้นของขอบเขต	getDefaultClientScopes
PUT /{realm}/default-default-client-scopes/{clientScopeId}	setScopeAsDefaultClientScope
ลบ /{realm}/default-default-client-scopes/{clientScopeId}	unsetScopeAsDefaultClientScope
รับลำดับชั้นของกลุ่ม	getDefaultGroupHierarchy
PUT /{realm}/default-groups/{groupId}	setGroupAsDefaultGroup
ลบ /{realm}/default-groups/{groupId}	unsetGroupAsDefaultGroup
รับขอบเขตไคลเอนต์เสริมของขอบเขต	getOptionalClientScopes
PUT /{realm}/default-Optional-client-scopes/{clientScopeId}	setScopeAsOptionalClientScope
ลบ /{realm}/default-Optional-client-scopes/{clientScopeId}	unsetScopeAsOptionalClientScope
รับเหตุการณ์ ส่งคืนเหตุการณ์ทั้งหมด หรือกรองตามพารามิเตอร์การสืบค้น URL ที่แสดงไว้ที่นี่	รับกิจกรรมทั้งหมด
ลบกิจกรรมทั้งหมด	ลบกิจกรรมทั้งหมด
รับการกำหนดค่าผู้ให้บริการเหตุการณ์ ส่งคืนออบเจ็กต์ JSON พร้อมการกำหนดค่าผู้ให้บริการเหตุการณ์	getEventsConfig
อัพเดตผู้ให้บริการเหตุการณ์ เปลี่ยนผู้ให้บริการเหตุการณ์และ/หรือการกำหนดค่า	updateEventsConfig
รับกลุ่มผู้ใช้ตามเส้นทาง	getGroupByPath
GET /{realm}/การแปลเป็นภาษาท้องถิ่น	getLocalizationLocales
POST /{อาณาจักร}/การแปล/{locale}	อัพเดต LocalizationTexts
รับ /{realm}/localization/{locale}	getLocalizationTexts
ลบ /{realm}/localization/{locale}	ลบ LocalizationTexts
รับ /{realm}/localization/{locale}/{key}	getLocalizationText
PUT /{realm}/localization/{locale}/{key}	บันทึก LocalizationText
ลบเซสชันผู้ใช้ทั้งหมด (Keycloak ส่งข้อยกเว้นเมื่อมีการเรียกสิ่งนี้)	ออกจากระบบผู้ใช้ทั้งหมด
การส่งออกขอบเขตที่มีอยู่บางส่วนเป็นไฟล์ JSON	ขอบเขตการส่งออกบางส่วน
การนำเข้าบางส่วนจากไฟล์ JSON ไปยังขอบเขตที่มีอยู่	ImportRealm บางส่วน
แจ้งนโยบายการเพิกถอนขอบเขตไปยังไคลเอนต์ที่มี URL ของผู้ดูแลระบบเชื่อมโยงอยู่ (Keycloak ส่งข้อยกเว้นเมื่อมีการเรียกสิ่งนี้)	ผลักดันนโยบายการเพิกถอน
ลบเซสชันผู้ใช้เฉพาะ	เพิกถอน UserSession
ทดสอบการเชื่อมต่อ LDAP	ทดสอบการเชื่อมต่อ LDAP
ทดสอบการเชื่อมต่อ SMTP กับผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน	ทดสอบ SMTPConnection
รับสิทธิ์การจัดการผู้ใช้	รับสิทธิ์การจัดการผู้ใช้
อัปเดตสิทธิ์การจัดการผู้ใช้	อัพเดต UserManagementPermissions

ผู้ทำแผนที่บทบาท

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับการแมปบทบาท	getGroupRoleMappings
เพิ่มการแมปบทบาทระดับขอบเขตให้กับกลุ่ม	เพิ่มGlobalRolesToGroup
รับการแมปบทบาทระดับขอบเขต	getGroupRealmRoleMappings
ลบการแมปบทบาทระดับขอบเขต	ลบ GroupRealmRoleMappings
รับบทบาทระดับขอบเขตที่สามารถแมปได้	getAvailableGroupRealmRoleMappings
รับการแมปบทบาทระดับขอบเขตที่มีประสิทธิภาพ ซึ่งจะเรียกซ้ำบทบาทคอมโพสิตทั้งหมดเพื่อให้ได้ผลลัพธ์	getEffectiveGroupRealmRoleMappings
รับการแมปบทบาท	getUserRoleMappings
เพิ่มการแมปบทบาทระดับขอบเขตให้กับผู้ใช้	เพิ่มGlobalRolesToUser
รับการแมปบทบาทระดับขอบเขต	getUserRealmRoleMappings
ลบการแมปบทบาทระดับขอบเขต	ลบ UserRealmRoleMappings
รับบทบาทระดับขอบเขตที่สามารถแมปได้	getAvailableUserRealmRoleMappings
รับการแมปบทบาทระดับขอบเขตที่มีประสิทธิภาพ ซึ่งจะเรียกซ้ำบทบาทคอมโพสิตทั้งหมดเพื่อให้ได้ผลลัพธ์	getEffectiveUserRealmRoleMappings

บทบาท

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างบทบาทใหม่สำหรับขอบเขตหรือลูกค้า (เฉพาะลูกค้า)	createClientRole
รับบทบาททั้งหมดสำหรับขอบเขตหรือลูกค้า (เฉพาะลูกค้า)	getClientRoles
รับบทบาทตามชื่อ (เฉพาะลูกค้า)	getClientRole
อัปเดตบทบาทตามชื่อ (เฉพาะลูกค้า)	อัพเดต ClientRole
ลบบทบาทตามชื่อ (เฉพาะลูกค้า)	ลบClientRole
เพิ่มคอมโพสิตให้กับบทบาท (เฉพาะลูกค้า)	addCompositeRoleToClientRole
รับส่วนประกอบของบทบาท (เฉพาะลูกค้า)	getClientRoleCompositeRoles
ลบบทบาทออกจากคอมโพสิตของบทบาท (เฉพาะลูกค้า)	ลบCompositeRoleFromClientRole
บทบาทระดับแอปสำหรับแอปที่ระบุสำหรับคอมโพสิตของบทบาท (เฉพาะไคลเอ็นต์)	getClientRoleCompositeRolesForClient
รับบทบาทระดับขอบเขตของคอมโพสิตของบทบาท (เฉพาะไคลเอนต์)	getClientRoleCompositeRolesForRealm
ส่งคืนรายชื่อกลุ่มที่มีชื่อบทบาทที่ระบุ (เฉพาะลูกค้า)	getClientRoleGroups
ส่งคืนออบเจ็กต์ที่ระบุว่าสิทธิ์อนุญาตบทบาทได้รับการเริ่มต้นแล้วหรือไม่และมีการอ้างอิง (เฉพาะไคลเอนต์)	getClientRoleManagement สิทธิ์
อัปเดตออบเจ็กต์ที่ระบุว่าสิทธิ์การอนุญาตบทบาทได้รับการเริ่มต้นแล้วหรือไม่และการอ้างอิง (เฉพาะไคลเอนต์)	updateClientRoleManagementPermissions
กลับรายการผู้ใช้ที่มีชื่อบทบาทที่ระบุ (Client เฉพาะ)	getClientRoleUsers
สร้างบทบาทใหม่สำหรับขอบเขตหรือไคลเอนต์	createRealmRole
รับบทบาททั้งหมดสำหรับขอบเขตหรือไคลเอนต์	รับRealmRoles
รับบทบาทตามชื่อ	รับRealmRole
อัปเดตบทบาทตามชื่อ	อัพเดต RealmRole
ลบบทบาทตามชื่อ	ลบRealmRole
เพิ่มคอมโพสิตให้กับบทบาท	เพิ่มCompositeRoleToRealmRole
รับคอมโพสิตของบทบาท	getRealmRoleCompositeRoles
ลบบทบาทออกจากการรวมของบทบาท	ลบCompositeRoleFromRealmRole
บทบาทระดับแอปสำหรับแอปที่ระบุสำหรับคอมโพสิตของบทบาท	getRealmRoleCompositeRolesForClient
รับบทบาทระดับขอบเขตของคอมโพสิตของบทบาท	getRealmRoleCompositeRolesForRealm
ส่งคืนรายชื่อกลุ่มที่มีชื่อบทบาทที่ระบุ	getRealmRoleGroups
ส่งคืนออบเจ็กต์ที่ระบุว่าสิทธิ์การอนุญาตบทบาทได้รับการเตรียมใช้งานหรือไม่ และมีการอ้างอิง	getRealmRoleManagement สิทธิ์
อัปเดตออบเจ็กต์ที่ระบุว่าสิทธิ์อนุญาตบทบาทได้รับการเตรียมใช้งานหรือไม่ และมีการอ้างอิง	อัปเดตสิทธิ์การจัดการ RealmRoleManagement
ส่งคืนรายชื่อผู้ใช้ที่มีชื่อบทบาทที่ระบุ	getRealmRoleUsers

บทบาท (ตาม ID)

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับตัวแทนของบทบาทเฉพาะ	รับ RealmRoleById
อัพเดตบทบาท	อัพเดต RealmRoleById
ลบบทบาท	ลบ RealmRoleById
ทำให้บทบาทเป็นบทบาทรวมโดยการเชื่อมโยงบทบาทย่อยบางบทบาท	เพิ่ม CompositeRoleToRealmRoleByRoleId
รับลูกของบทบาท ส่งกลับชุดลูกของบทบาทโดยที่บทบาทเป็นแบบผสม	getRealmRoleCompositeRolesByRoleId
ลบชุดของบทบาทออกจากการรวมของบทบาท	ลบCompositeRoleFromRealmRoleByRoleId
รับบทบาทระดับไคลเอนต์สำหรับลูกค้าที่อยู่ในการรวมของบทบาท	getRealmRoleCompositeRolesForClientByRoleId
รับบทบาทระดับขอบเขตที่อยู่ในองค์ประกอบรวมของบทบาท	getRealmRoleCompositeRolesForRealmByRoleId
ส่งคืนออบเจ็กต์ที่ระบุว่าสิทธิ์การอนุญาตบทบาทได้รับการเตรียมใช้งานหรือไม่ และมีการอ้างอิง	getRealmRoleManagement สิทธิ์ ByRoleId
ส่งคืนออบเจ็กต์ที่ระบุว่าสิทธิ์การอนุญาตบทบาทได้รับการเตรียมใช้งานหรือไม่ และมีการอ้างอิง	อัปเดต RealmRoleManagementPermissionsByRoleId

การแมปขอบเขต

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับการแมปขอบเขตทั้งหมดสำหรับลูกค้า
เพิ่มบทบาทระดับไคลเอนต์ให้กับขอบเขตของลูกค้า
รับบทบาทที่เกี่ยวข้องกับขอบเขตของลูกค้า ส่งคืนบทบาทให้กับลูกค้า
ลบบทบาทระดับไคลเอนต์ออกจากขอบเขตของลูกค้า
บทบาทระดับไคลเอ็นต์ที่มีอยู่ ส่งคืนบทบาทสำหรับลูกค้าที่สามารถเชื่อมโยงกับขอบเขตของลูกค้าได้
รับบทบาทลูกค้าที่มีประสิทธิผล ส่งกลับบทบาทสำหรับลูกค้าที่เกี่ยวข้องกับขอบเขตของลูกค้า
เพิ่มชุดของบทบาทระดับขอบเขตให้กับขอบเขตของไคลเอ็นต์
รับบทบาทระดับขอบเขตที่เกี่ยวข้องกับขอบเขตของลูกค้า
ลบชุดของบทบาทระดับขอบเขตออกจากขอบเขตของไคลเอ็นต์
รับบทบาทระดับขอบเขตที่พร้อมแนบไปกับขอบเขตของลูกค้ารายนี้
รับบทบาทระดับขอบเขตที่มีประสิทธิผลซึ่งเชื่อมโยงกับขอบเขตของลูกค้า ซึ่งการดำเนินการนี้จะเป็นการเรียกซ้ำบทบาทคอมโพสิตใดๆ ที่เกี่ยวข้องกับขอบเขตของลูกค้า และเพิ่มบทบาทลงในรายการนี้
รับการแมปขอบเขตทั้งหมดสำหรับลูกค้า
เพิ่มบทบาทระดับไคลเอนต์ให้กับขอบเขตของลูกค้า
รับบทบาทที่เกี่ยวข้องกับขอบเขตของลูกค้า ส่งคืนบทบาทให้กับลูกค้า
ลบบทบาทระดับไคลเอนต์ออกจากขอบเขตของลูกค้า
บทบาทระดับไคลเอ็นต์ที่มีอยู่ ส่งคืนบทบาทสำหรับลูกค้าที่สามารถเชื่อมโยงกับขอบเขตของลูกค้าได้
รับบทบาทลูกค้าที่มีประสิทธิผล ส่งกลับบทบาทสำหรับลูกค้าที่เกี่ยวข้องกับขอบเขตของลูกค้า
เพิ่มชุดของบทบาทระดับขอบเขตให้กับขอบเขตของไคลเอ็นต์
รับบทบาทระดับขอบเขตที่เกี่ยวข้องกับขอบเขตของลูกค้า
ลบชุดของบทบาทระดับขอบเขตออกจากขอบเขตของไคลเอ็นต์
รับบทบาทระดับขอบเขตที่พร้อมแนบไปกับขอบเขตของลูกค้ารายนี้
รับบทบาทระดับขอบเขตที่มีประสิทธิผลซึ่งเชื่อมโยงกับขอบเขตของลูกค้า ซึ่งการดำเนินการนี้จะเป็นการเรียกซ้ำบทบาทคอมโพสิตใดๆ ที่เกี่ยวข้องกับขอบเขตของลูกค้า และเพิ่มบทบาทลงในรายการนี้

ผู้ให้บริการจัดเก็บข้อมูลผู้ใช้

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
จำเป็นต้องใช้สิ่งนี้เพื่อให้คอนโซลผู้ดูแลระบบแสดงชื่อผู้ให้บริการแบบง่ายเมื่อแสดงรายละเอียดไคลเอนต์ KEYCLOAK-4328
จำเป็นต้องใช้สิ่งนี้เพื่อให้คอนโซลผู้ดูแลระบบแสดงชื่อผู้ให้บริการแบบง่ายเมื่อแสดงรายละเอียดผู้ใช้ KEYCLOAK-4328
ลบผู้ใช้ที่นำเข้า
ทริกเกอร์การซิงค์ของผู้ใช้ การดำเนินการอาจเป็น "triggerFullSync" หรือ "triggerChangedUsersSync"
ยกเลิกการเชื่อมโยงผู้ใช้ที่นำเข้าจากผู้ให้บริการพื้นที่เก็บข้อมูล
ทริกเกอร์การซิงค์ข้อมูลตัวทำแผนที่ที่เกี่ยวข้องกับทิศทางของตัวทำแผนที่ ldap (บทบาท กลุ่ม …​) คือ "fedToKeycloak" หรือ "keycloakToFed"

ผู้ใช้

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
สร้างผู้ใช้ใหม่ ชื่อผู้ใช้จะต้องไม่ซ้ำกัน	createUser
รับผู้ใช้ ส่งคืนรายชื่อผู้ใช้ กรองตามพารามิเตอร์การสืบค้น	getUsers
GET /{realm}/users/count	getUserCount
รับตัวแทนของผู้ใช้	getUser
อัปเดตผู้ใช้	อัปเดตผู้ใช้
ลบผู้ใช้	ลบผู้ใช้
รับความยินยอมที่ได้รับจากผู้ใช้
เพิกถอนความยินยอมและโทเค็นออฟไลน์สำหรับลูกค้ารายใดรายหนึ่งจากผู้ใช้
ปิดการใช้งานข้อมูลรับรองทั้งหมดสำหรับผู้ใช้ประเภทใดประเภทหนึ่ง
ส่งอีเมลบัญชีอัปเดตไปยังผู้ใช้ อีเมลมีลิงก์ที่ผู้ใช้สามารถคลิกเพื่อดำเนินการชุดการดำเนินการที่จำเป็น	ดำเนินการ ActionsEmail
รับการเข้าสู่ระบบโซเชียลที่เกี่ยวข้องกับผู้ใช้
เพิ่มผู้ให้บริการล็อกอินโซเชียลให้กับผู้ใช้
ลบผู้ให้บริการเข้าสู่ระบบโซเชียลออกจากผู้ใช้
GET /{realm}/users/{id}/groups	getUserGroups
GET /{realm}/users/{id}/groups/count	getUserGroupsCount
PUT /{realm}/users/{id}/groups/{groupId}	addUserToGroup
ลบ /{realm}/users/{id}/groups/{groupId}	ลบ UserFromGroup
ปลอมตัวเป็นผู้ใช้	แอบอ้างเป็นผู้ใช้
ลบเซสชันผู้ใช้ทั้งหมดที่เกี่ยวข้องกับผู้ใช้ ส่งการแจ้งเตือนไปยังไคลเอนต์ทั้งหมดที่มี URL ผู้ดูแลระบบเพื่อทำให้เซสชันไม่ถูกต้องสำหรับผู้ใช้นั้น ๆ	ออกจากระบบผู้ใช้
รับเซสชันออฟไลน์ที่เกี่ยวข้องกับผู้ใช้และไคลเอนต์
ลบ TOTP ออกจากผู้ใช้
ตั้งค่ารหัสผ่านใหม่ให้กับผู้ใช้	รีเซ็ตรหัสผ่านผู้ใช้
ส่งอีเมลยืนยันอีเมลถึงผู้ใช้ อีเมลมีลิงก์ที่ผู้ใช้สามารถคลิกเพื่อยืนยันที่อยู่อีเมลของตน	sendVerifyEmail
รับเซสชันที่เกี่ยวข้องกับผู้ใช้	getUserSessions
รับข้อมูลรับรองที่เกี่ยวข้องกับผู้ใช้	getUserCredentials
ลบข้อมูลรับรองที่เกี่ยวข้องกับผู้ใช้	ลบข้อมูลรับรองผู้ใช้

ราก

เอพีไอ	ชื่อฟังก์ชัน	รองรับ
รับธีม ผู้ให้บริการโซเชียล ผู้ให้บริการการรับรองความถูกต้อง และผู้ฟังเหตุการณ์ที่มีอยู่บนเซิร์ฟเวอร์นี้
CORS พรีไฟลต์