首頁>編程相關>其他源碼
下載

DfE 登入公共 API

供外部消費者與 DfE 登入互動的 API

您需要使用這些 API 進行身份驗證

要使用下面的任何API，您需要在請求標頭中提供不記名令牌，該不記名令牌只是一個JWT（請參閱https://jwt.io），帶有一個簡單的有效負載，該有效負載使用以下密鑰進行簽名：只需登入 DfE 即可知道。

您應該使用所選技術附帶的標準 JWT 庫在呼叫應用程式中使用時建立 JWT。

令牌主體將需要發行者（您的服務用戶端 ID）和受眾，如下所示： 

{
  "iss": "REPLACE_WITH_YOUR_CLIENT_ID",
  "aud": "signin.education.gov.uk"
}

令牌必須使用 HS256 演算法和您的 API_SECRET 進行簽署。在與 DfE 登入整合時，您將獲得一個 API_SECRET（不要與您的 CLIENT_SECRET 混淆），如果您沒有此訊息，請聯絡 DfE 登入團隊，我們將為您重新產生一個（這些是特定於服務/環境。）

使用 Postman 評估和測試 API

郵差概述

Postman 是一個 API 平台工具，用於建立和執行 API。 Postman 簡化了 API 生命週期的每個步驟，並廣泛用於 DfE 登入公共 API 的開發和文件編制。

我們提供了一套 Postman 集合及其關聯的執行環境，以協助您透過公共 API 學習、測試和調試與 DfE 登入平台的整合。

Postman 和 DfE 登入收集套件入門

Postman API 平台工具可用作桌面用戶端、託管 Web 應用程式和命令列介面 (CLI)，網址為 https://www.postman.com/api-platform/api-client/。

DfE 登入公用 API Postman 集合和環境位於 https://github.com/DFE-Digital/login.dfe.public-api/tree/develop/Postman/。

邀請用戶

作為登入 DfE 登入的服務，您可以使用 API 邀請使用者使用該服務。

請求看起來像

POST https://environment-url/services/{service-id}/invitations
Authorization: bearer {jwt-token}

{
    "sourceId": "user_id_in_your_service",
	"given_name": "John",
	"family_name": "Smith",
	"email": "[email protected]",
	"callback": "https://me.service.url/users/signup-complete"
}

可變資料項是：

姓名地點必需的描述
服務ID網址是您邀請使用者使用的服務的 DfE 登入標識符
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您
來源ID身體是您系統中使用者的識別碼。將包含在反向通道回應中
給定的名稱身體是用戶的名字
姓身體是使用者姓氏
電子郵件身體是使用者的電子郵件地址。這也是 DfE 登入中使用者的唯一識別符
組織身體
使用者應關聯到的 DfE 登入標識符
打回來身體
反向通道回應應發送到的 URL。請參閱下面的反向通道響應的詳細信息
使用者重定向身體
用戶在完成註冊後應返回的 URL。如果省略，將使用您的客戶端的預設重新導向
邀請主題覆蓋身體
覆蓋邀請電子郵件的主題
邀請正文覆蓋身體
覆蓋邀請電子郵件的內容

可能的回應代碼有：

HTTP 狀態碼原因
第202章您的請求已被接受
400您的請求無效。其他詳細資訊將在回應正文中提供
401您的 JWT 遺失或無效。
404 uri中的服務id不存在
500伺服器發生錯誤。請確保正確配置機密、API 金鑰或令牌等機密。如果問題仍然存在，請聯絡支援團隊尋求協助

當發出請求時，使用者可能存在於系統中，也可能不存在；並且可能有也可能沒有所要求的所需組織和服務映射。因此，所有用戶詳細資訊都透過反向通道回應發送。如果在 DfE 登入中（透過電子郵件）找到用戶，則可能會立即發生這種情況；或一旦用戶接受將發送給他們的邀請電子郵件。

反向通道響應如下所示： 

POST https://callback.url/from/request
Authorization: bearer {jwt-token}

{
    "sub": "some-uuid",
    "sourceId: "source-id-from-request"
}

請求中的資料項為：

姓名地點描述
jwt 令牌標頭jwt 令牌，使用與請求相同的金鑰進行簽名
子身體DfE 使用者的登入識別碼。這不會改變，並將作為子索賠包含在 OIDC 回覆中
來源ID身體原始請求中使用的sourceId

管理公告

可以為組織發布和取消發佈公告。

公告可以透過以下方式發布： 

POST https://environment-url/organisations/announcements
Authorization: bearer {jwt-token}

{
    "messageId": "your-unique-idenitifer",
	"urn": "12345",
	"type": 1,
	"title": "Title of announcement",
	"summary": "summary of announcement",
	"body": "body of announcement",
	"publishedAt": "2019-01-31T20:30:40Z",
	"expiresAt": "2020-01-31T20:30:40Z"
}

公告架構如下：

屬性必需的描述類型
訊息ID是來源系統中訊息的標識符。必須是獨一無二的通用唯一識別符
甕Y（或 uid）機構 URN數位
uid Y（或甕）組UID通用唯一識別符
類型是訊息的數字類型代碼（見下文）整數
標題是公告的標題。最大字元數限制 255文字或 HTML
概括是公告摘要。最大字元數限制 340文字或 HTML
身體是公告正文。最大字元數限制 5000文字或 HTML
發表於是發布日期/時間公告於ISO8601
過期時間
日期/時間公告應到期於ISO8601

可能的回應代碼有：

HTTP 狀態碼原因
第202章您的請求已被接受
400您的請求無效。其他詳細資訊將在回應正文中提供
401您的 JWT 遺失或無效。
500伺服器發生錯誤。請確保正確配置機密、API 金鑰或令牌等機密。如果問題仍然存在，請聯絡支援團隊尋求協助

有效的公告類型有：

程式碼意義
1關於設立記錄的警告
2營業記錄有問題
4關於治理記錄的警告
5治理記錄存在問題

隨後可以透過以下方式取消發佈公告： 

DELETE https://environment-url/organisations/announcements/your-unique-idenitifer
Authorization: bearer {jwt-token}

其中your-unique-idenitifer是發布訊息時發送的 messageId。

可能的回應代碼有：

HTTP 狀態碼原因
204公告尚未發布
401您的 JWT 遺失或無效。
404 uri中的消息id不存在
500伺服器發生錯誤。請確保正確配置機密、API 金鑰或令牌等機密。如果問題仍然存在，請聯絡支援團隊尋求協助

創建子應用程式

如果您的應用程式已啟用，您可以透過 API 建立子應用程式。這些子應用程式適用於當您擁有第三方應用程式時，這些應用程式將使用 OIDC 同意流程，使它們能夠在使用者上下文中呼叫您的應用程式中的 API。

子應用程式可以透過以下方式建立： 

POST https://environment-url/services
Authorization: bearer {jwt-token}

{
	"name": "The display name of the application",
	"description": "A description of what the application does",
	"consentTitle": "Override for the content at the top of the Consent Screen",
	"consentBody": "Override for the content of the Consent Screen",
	"redirectUris": [
	    "https://endpoint.one/auth/cb",
	    "https://endpoint.two/login/callback"
	]
}

關於同意範本覆蓋的注意事項
兩個參數允許覆蓋同意畫面中向使用者顯示的內容、標題和正文（根據當前表單設計，其他所有內容都是靜態的）。 覆蓋值是一個具有兩個（可選）動態值的字串。例如， consentTitle="Do you want to allow {{applicationName}} to send data to us for {{roleScope}}"

一個應用程式的結構如下：

屬性必需的描述
姓名是應用程式的用戶友好名稱。這將在提示使用者同意時使用
描述氮應用程式的描述
重定向Uris是可在 OIDC 登入/同意流程中使用的重定向 uri 數組

可能的回應代碼有：

HTTP 狀態碼原因
201您的子應用程式已創建
400您的請求無效。其他詳細資訊將在回應正文中提供
403您的應用程式沒有創建子應用程式的權限

成功建立子應用程式後，您將收到以下回應： 

{
	"name": "The display name of the application",
	"description": "A description of what the application does",
	"clientId": "child-application-clientid",
	"clientSecret": "child-application-clientsecret",
	"redirectUris": [
	    "https://endpoint.one/auth/cb",
	    "https://endpoint.two/login/callback"
	]
}

name 、 description和redirectUris是對從您的要求收到的內容的確認。 clientId和clientSecret是子應用程式在執行 OIDC 流程時需要使用的內容。您還需要clientId來進行應用程式的任何後續管理。

如果子應用程式的機密被洩露，您可以透過以下方式要求重新產生機密： 

POST https://environment-url/services/client-id-of-child-application/regenerate-secret
Authorization: bearer {jwt-token}

可能的回應代碼有：

HTTP 狀態碼原因
200秘密已重新生成
403指定的客戶端 ID 不是您的應用程式的子級
404找不到具有指定客戶端 ID 的應用程式

成功重新產生密鑰後，您將收到以下回應： 

{
    "clientSecret": "regenerated-client-secret"
}

子應用程式贈款和代幣

子應用程式遵循明確的同意流程，最終產生授權代碼（授權），可以將其交換為短期存取令牌和長期刷新令牌，以便允許子應用程式所有者管理我們提供的已發行令牌的生命週期一個方便的API，用於列出政府子應用程式的撥款和令牌問題。

然後可以使用標準 open id 連線端點（內省和撤銷）來檢查和撤銷這些令牌。

要取得給定兒童服務的補助金清單： 

GET https://environment-url/services/{service-id}/grants

若要取得為給定子服務授予頒發的令牌清單： 

GET https://environment-url/services/{service-id}/grants/{grant-id}/tokens

取得使用者對服務的存取權限

您可以使用此 API 來取得使用者對組織服務的存取權限。請求看起來像

GET https://environment-url/services/{service-id}/organisations/{organisation-id}/users/{user-id}
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
服務ID網址是服務的 DfE 登入標識符
組織ID網址是組織的 DfE 登入標識符
使用者身分網址是使用者的 DfE 登入標識符
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

這將傳回以下格式的回應

{
    "userId": "user-id",
    "serviceId": "service-id",
    "organisationId": "organisation-id",
    "roles": [
        {
            "id": "role-id",
            "name": "The name of the role",
            "code": "The code of the role",
            "numericId": "9999",
            "status": {
                "id": 1
            }
        }
    ],
    "identifiers": [
        {
            "key": "identifier-key",
            "value": "identifier-value"
        }
    ]
}

注意：如果使用者沒有指定的服務或不在指定的組織中，則會傳回狀態代碼404（未找到） 。

取得使用者的組織

您可以使用此 API 取得與使用者關聯的組織 該請求如下所示

GET https://environment-url/users/{user-id}/organisations
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
使用者身分網址是使用者的 DfE 登入標識符
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

這將傳回以下格式的回應

[
    {
        "id": "org-id",
        "name": "Organisation name",
        "category": {
            "id": "004",
            "name": "Early Year Setting"
        },
        "urn": "org-urn",
        "uid": null,
        "ukprn": null,
        "establishmentNumber": null,
        "status": {
            "id": 1,
            "name": "Open"
        },
        "closedOn": null,
        "address": null,
        "telephone": null,
        "statutoryLowAge": null,
        "statutoryHighAge": null,
        "legacyId": "legacy-id",
        "companyRegistrationNumber": null
    },
]

取得服務角色

您可以使用此 API 端點來取得與您的服務或您的子服務之一關聯的角色。該請求如下所示： 

GET https://environment-url/services/{client-id}/roles
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
客戶端 ID網址是服務的 DfE 登入客戶端標識符
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

可能的回應代碼有：

HTTP 狀態碼原因
200已成功檢索到所請求客戶端 ID 的角色清單（可能為空）。
403指定的客戶端 ID 不是您的服務，也不是您的服務的子服務。
404找不到具有指定客戶端 ID 的服務。

這將傳回以下格式的回應： 

[
    {
        "name": "Role 1 Name",
        "code": "Role1Code",
        "status": "Active"
    },
    {
        "name": "Role 2 Name",
        "code": "Role2Code",
        "status": "Inactive"
    }
]

如果未找到角色，則執行以下操作： 

[]

取得使用者的組織，包括提供者設定檔組織屬性

您可以使用此 API 取得與使用者關聯的組織 該請求如下所示

GET https://environment-url/users/{user-id}/v2/organisations
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
使用者身分網址是使用者的 DfE 登入標識符
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

這將傳回以下格式的回應

[
    {
        "id": "org-id",
        "name": "Organisation name",
        "category": {
            "id": "001",
            "name": "Establishment"
        },
        "urn": null,
        "uid": null,
        "upin": "111111",
        "ukprn": "21133510",
        "establishmentNumber": null,
        "status": {
            "id": 1,
            "name": "Open"
        },
        "closedOn": null,
        "address": "Organisation address",
        "telephone": null,
        "statutoryLowAge": null,
        "statutoryHighAge": null,
        "legacyId": "1111",
        "companyRegistrationNumber": null,
        "DistrictAdministrativeCode": null,
        "DistrictAdministrative_code": null,
        "providerTypeName": "Commercial and Charitable Provider",
        "ProviderProfileID": "7777777",
        "OpenedOn": null,
        "SourceSystem": "PIMS",
        "GIASProviderType": null,
        "PIMSProviderType": "Private Limited Company",
        "PIMSProviderTypeCode": 11,
        "PIMSStatus": "1",
        "masteringCode": null,
        "PIMSStatusName": "",
        "GIASStatus": null,
        "GIASStatusName": null,
        "MasterProviderStatusCode": 1,
        "MasterProviderStatusName": "Active",
        "LegalName": "Org Legal Name"
    },
]

沒有過濾器的服務用戶

您可以獲得授權令牌（iss 屬性）中定義的不含過濾器的使用者清單
該請求如下所示： 

GET https://environment-url/users?page=1&pageSize=25
Authorization: bearer {jwt-token}

page 和 pageSize 變數是可選的，分別預設為 1 和 25，這些變數允許呼叫者迭代結果頁（使用回應正文中的屬性來計算記錄數和頁數）。

回應正文包含以下屬性（下面的回應範例）：

姓名描述
使用者使用者詳細資料數組（包括子組織物件）
記錄數報告的記錄總數
頁目前頁碼
頁數總頁數

回應範例

{「使用者」：[
        {“approvedAt”：“2019-06-19T15：09：58.683Z”，“updatedAt”：“2019-06-19T15：09：58.683Z”，“組織”：{“id”：“13F20E54-79EA-41469EA- -8E39-18197576F023”，“名稱”：“教育部”，“類別”：“002”，“類型”：空，“URN”：空，“UID”：空，“UKPRN”：空，“EstablishmentNumber " : "001"、"狀態": 1、"ClosedOn": null、"地址": null、"phaseOfEducation": null、"statutoryLowAge": null、"statutoryHighAge": null、"電話": null、"regionCode " : null, "legacyId": "1031237", "companyRegistrationNumber": "1234567", "ProviderProfileID": "", "UPIN": "", "PIMSProviderType": "中央政府部門", "PIMSStatus": "" 、 「DistrictAdministrativeName」：「」、「OpenedOn」：「2007-09-01T00:00:00.0000000Z」、「SourceSystem」：「」、「ProviderTypeName」：「政府機構」、「GIASProviderType」：「」、「PIMSProviderType」 ": "", "createdAt": "2019-02-20T14:27:59.020Z", "updatedAt": "2019-02-20T14:28:38.223Z"
            }, "roleName": "審核者", "roleId": 10000, "userId": "21D62132-6570-4E63-9DCB-137CC35E7543", "userStatus": 1, "電子郵件": "[email protected] ", “familyName”：“約翰遜”，“givenName”：“羅傑”
        }
    ], "記錄數": 1, "頁數": 1, "頁數": 1}

帶有過濾器的服務用戶

您可以取得具有授權令牌（iss 屬性）中定義的篩選器的使用者清單
該請求如下所示： 

GET https://environment-url/users?page=1&pageSize=25&status=0&from=2021%2F02%2F11%2002%3A22%3A06&to=2021%2F11%2F03%2002%3A22%3A06
Authorization: bearer {jwt-token}

page 和 pageSize 變數是可選的，分別預設為 1 和 25，這些變數允許呼叫者迭代結果頁（使用回應正文中的屬性來計算記錄數和頁數）。 status、from 和 to 是可選狀態，目前接受 0。日期範圍僅接受 7 天 日期應採用 URL 編碼形式，如範例所示

日期範圍驗證當日期範圍超過 7 天時發送錯誤訊息。僅過濾器中的起始日期會在起始日期後 7 天更新使用者。過濾器中的「僅截止日期」會在截止日期之前 7 天更新使用者。如果未指定日期，則讓使用者從現在到該日期之前的 7 天進行更新。

回應正文包含以下屬性（下面的回應範例）：

姓名描述
使用者使用者詳細資料數組（包括子組織物件）
記錄數報告的記錄總數
頁目前頁碼
頁數總頁數
警告（可選）僅在僅獲取 7 天的用戶時出現

回應範例

{「使用者」：[
        {“approvedAt”：“2019-06-19T15：09：58.683Z”，“updatedAt”：“2019-06-19T15：09：58.683Z”，“組織”：{“id”：“13F20E54-79EA-41469EA- -8E39-18197576F023”，“名稱”：“教育部”，“類別”：“002”，“類型”：空，“URN”：空，“UID”：空，“UKPRN”：空，“EstablishmentNumber " : "001"、"狀態": 1、"ClosedOn": null、"地址": null、"phaseOfEducation": null、"statutoryLowAge": null、"statutoryHighAge": null、"電話": null、"regionCode " : null, "legacyId": "1031237", "companyRegistrationNumber": "1234567", "ProviderProfileID": "", "UPIN": "", "PIMSProviderType": "中央政府部門", "PIMSStatus": "" 、 「DistrictAdministrativeName」：「」、「OpenedOn」：「2007-09-01T00:00:00.0000000Z」、「SourceSystem」：「」、「ProviderTypeName」：「政府機構」、「GIASProviderType」：「」、「PIMSProviderType」 ": "", "createdAt": "2019-02-20T14:27:59.020Z", "updatedAt": "2019-02-20T14:28:38.223Z"
            }, "roleName": "審核者", "roleId": 10000, "userId": "21D62132-6570-4E63-9DCB-137CC35E7543", "userStatus": 1, "電子郵件": "[email protected] ", “familyName”：“約翰遜”，“givenName”：“羅傑”
        }
    ], "numberOfRecords": 1, "page": 1, "numberOfPages": 1, "warning": "只能取得7天的資料"}

若要解釋類別 ID，請參閱此處。

組織審核人

如果您的服務有權限，您可以取得您的服務範圍內的組織的審核者清單（基於角色策略條件）。

該請求如下所示： 

GET https://environment-url/users/approvers?page=1&pageSize=25
Authorization: bearer {jwt-token}

page 和 pageSize 變數是可選的，分別預設為 1 和 25，這些變數允許呼叫者迭代結果頁（使用回應正文中的屬性來計算記錄數和頁數）。

回應正文包含以下屬性（下面的回應範例）：

姓名描述
使用者使用者詳細資料數組（包括子組織物件）
記錄數報告的記錄總數
頁目前頁碼
頁數總頁數

回應範例

可能的回應代碼有：

HTTP 狀態碼原因
200您的請求已被接受
400您的請求無效。其他詳細資訊將在回應正文中提供
401您的 JWT 遺失或無效。
403您的應用程式無權獲得組織的批准
500伺服器發生錯誤。請確保正確配置機密、API 金鑰或令牌等機密。如果問題仍然存在，請聯絡支援團隊尋求協助
{「使用者」：[
        { "organization": { "id": "13F20E54-79EA-4146-8E39-18197576F023", "name": "教育部", "category": { "id": "002", "name": "地方教育部", "category": { "id": "002", "name": "地方教育部", "category": { "id": "002", "name": "地方當局”
                }, "urn": null, "uid": null, "ukprn": null, "buildingNumber": "001", "status": { "id": 1, "name": "開放"
                }，“closeOn”：null，“地址”：null，“電話”：null，“statutoryLowAge”：null，“statutoryHighAge”：null，“legacyId”：“1031237”，“companyRegistrationNumber”：“1234567”，“ProviderProfile 」 ": "", "UPIN": "", "PIMSProviderType": "中央政府部門", "PIMSStatus": "", "DistrictAdministrativeName": "", "OpenedOn": "2007-09-01T00:00: 00.0000000 Z", "SourceSystem": "", "ProviderTypeName": "政府機構", "GIASProviderType": "", "PIMSProviderTypeCode": ""
            }, "roleId": 10000, "roleName": "審核者", "userId": "21D62132-6570-4E63-9DCB-137CC35E7543", "userStatus": 1, "電子郵件": "[email protected] ", “familyName”：“約翰遜”，“givenName”：“羅傑”
        }
    ], "記錄數": 1, "頁數": 1, "頁數": 1}

使用 UKPRN 按角色取得組織用戶

您可以使用此 API 來取得按角色過濾的組織使用者請求如下所示

GET https://environment-url/organisations/{UKPRN}/users?roles=role1,role2
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
英國PRN網址是該組織的 UKPRN
角色網址氮用於過濾組織使用者清單的使用者角色代碼
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

可能的回應代碼包括：

HTTP 狀態碼原因
200已成功檢索到所請求組織的角色
400您的請求無效。其他詳細資訊將在回應正文中提供
401您的 JWT 遺失或無效
403您的應用程式缺乏檢索該組織使用者的權限
404找不到具有所請求組織的指定角色的用戶，導致數組為空
500伺服器發生錯誤。請確保正確配置機密、API 金鑰或令牌等機密。如果問題仍然存在，請聯絡支援團隊尋求協助

這將傳回以下格式的回應

{
    "ukprn": "organisation-ukprn-id",
    "users": [
        {
            "email": "[email protected]",
            "firstName": "user1",
            "lastName": "test",
            "userStatus": 1,
            "roles": [
                "role1"
            ]
        },
        {
            "email": "[email protected]",
            "firstName": "user2",
            "lastName": "test",
            "roles": [
                "role1",
                "role2"
            ]
        }
    ]
}

依篩選條件檢索組織用戶

您也可以使用上述 API 根據篩選條件（例如電子郵件地址或使用者 ID）檢索組織使用者。請求看起來像

GET https://environment-url/organisations/{UKPRN}/[email protected]
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
英國PRN網址是該組織的 UKPRN
電子郵件網址氮用於過濾的使用者的電子郵件地址
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

回應格式與先前的 API 呼叫相同，允許按特定條件進行過濾。

使用 UPIN 按角色取得組織用戶

您可以使用此 API 來取得按角色過濾的組織使用者請求如下所示

GET https://environment-url/organisations/{UPIN}/users?roles=role1,role2
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
烏賓網址是組織的 UPIN
角色網址氮用於過濾組織使用者清單的使用者角色代碼
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

可能的回應代碼包括：

HTTP 狀態碼原因
200已成功檢索到所請求組織的角色
400您的請求無效。其他詳細資訊將在回應正文中提供
401您的 JWT 遺失或無效
403您的應用程式缺乏檢索該組織使用者的權限
404找不到具有所請求組織的指定角色的用戶，導致數組為空
500伺服器發生錯誤。請確保正確配置機密、API 金鑰或令牌等機密。如果問題仍然存在，請聯絡支援團隊尋求協助

這將傳回以下格式的回應

{
    "upin": "organisation-upin-id",
    "users": [
        {
            "email": "[email protected]",
            "firstName": "user1",
            "lastName": "test",
            "userStatus": 1,
            "roles": [
                "role1"
            ]
        },
        {
            "email": "[email protected]",
            "firstName": "user2",
            "lastName": "test",
            "roles": [
                "role1",
                "role2"
            ]
        }
    ]
}

依篩選條件檢索組織用戶

您也可以使用上述 API 根據篩選條件（例如電子郵件地址或使用者 ID）檢索組織使用者。請求看起來像

GET https://environment-url/organisations/{UPIN}/[email protected]
Authorization: bearer {jwt-token}

可變資料項是：

姓名地點必需的描述
烏賓網址是組織的 UPIN
電子郵件網址氮用於過濾的使用者的電子郵件地址
jwt 令牌標頭是用於授權的 JWT 令牌應使用您的 API 金鑰進行簽名，該金鑰將提供給您

回應格式與先前的 API 呼叫相同，允許按特定條件進行過濾。

id 如何映射到類別和類型？

組織類別

ID描述
001機構（請參閱下面的機構類型）
002地方當局
003其他遺留組織
004早年設置
008其他利害關係人
009培訓機構
010多學院信託
011政府
012其他 GIAS 利害關係人
013單一學院信託
050軟體供應商
051繼續教育

機構類型

ID描述
001社區學校
002志願資助學校
003自願控制學校
005基礎學校
006城市科技學院
007社區特殊學校
008非維持特殊學校
010其他獨立特殊學校
011其他獨立學校
012基金會特殊學校
014學生轉介單位
015洛杉磯幼兒園
018繼續教育
024安全單位
025離岸學校
026服務兒童教育
027雜項
028學院贊助商主導
029高等教育機構
030威爾斯機構
031六年級中心
032特崗16機構
033學院特別贊助商主導
034學院轉換器
035免費學校
036免費學校特別
037英國海外學校
038免費學校 - 替代性規定
039免費學校 - 16-19
040大學技術學院
041工作室學校
042學院替代規定轉換器
043學院替代規定贊助商主導
044學院專用轉換器
045學院 16-19 轉換器
046學院 16-19 贊助商主導
047奇爾德雷
展開
附加信息
  • 版本 v4.0.0
  • 類型 其他源碼
  • 更新時間 2025-01-03
  • 大小 167.99KB
  • 來自於 Github
相關應用
爲您推薦
相關資訊 全部