供外部消费者与 DfE 登录交互的 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 平台工具,用于构建和执行 API。 Postman 简化了 API 生命周期的每个步骤,并广泛用于 DfE 登录公共 API 的开发和文档编制。
我们提供了一套 Postman 集合及其关联的执行环境,以帮助您通过公共 API 学习、测试和调试与 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-4146 -8E39-18197576F023”, “名称”:“教育部”,“类别”:“002”,“类型”:null,“URN”:null,“UID”:null,“UKPRN”:null,“EstablishmentNumber”:“001”, “状态”:1,“关闭”:空,“地址”:空,“phaseOfEducation”:空,“statutoryLowAge”:空, “statutoryHighAge”:null,“电话”:null,“regionCode”:null,“legacyId”:“1031237”,“companyRegistrationNumber”:“1234567”,“ProviderProfileID”:“”,“UPIN”:“”,“PIMSProviderType” ": "中央政府部门", "PIMSStatus": "", "DistrictAdministrativeName": "", “OpenedOn”:“2007-09-01T00:00:00.0000000Z”,“SourceSystem”:“”,“ProviderTypeName”:“政府机构”,“GIASProviderType”:“”,“PIMSProviderTypeCode”:“”,“createdAt” :“2019-02-20T14:27:59.020Z”, “更新时间”:“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-4146 -8E39-18197576F023”, “名称”:“教育部”,“类别”:“002”,“类型”:null,“URN”:null,“UID”:null,“UKPRN”:null,“EstablishmentNumber”:“001”, “状态”:1,“关闭”:空,“地址”:空,“phaseOfEducation”:空,“statutoryLowAge”:空, “statutoryHighAge”:null,“电话”:null,“regionCode”:null,“legacyId”:“1031237”,“companyRegistrationNumber”:“1234567”,“ProviderProfileID”:“”,“UPIN”:“”,“PIMSProviderType” ": "中央政府部门", "PIMSStatus": "", "DistrictAdministrativeName": "", “OpenedOn”:“2007-09-01T00:00:00.0000000Z”,“SourceSystem”:“”,“ProviderTypeName”:“政府机构”,“GIASProviderType”:“”,“PIMSProviderTypeCode”:“”,“createdAt” :“2019-02-20T14:27:59.020Z”, “更新时间”:“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": "地方当局” }, "urn": null, "uid": null, "ukprn": null, "buildingNumber": "001", "status": { "id": 1, "name": "开放" },“closeOn”:null,“地址”:null,“电话”:null,“statutoryLowAge”:null,“statutoryHighAge”:null,“legacyId”:“1031237”,“companyRegistrationNumber”:“1234567”,“ProviderProfileID” ": "", "UPIN": "", "PIMSProviderType": "中央政府部门", “PIMSStatus”:“”,“DistrictAdministrativeName”:“”,“OpenedOn”:“2007-09-01T00:00:00.0000000Z”,“SourceSystem”:“”,“ProviderTypeName”:“政府机构”,“GIASProviderType” : "", "PIMSProviderTypeCode": "" }, "roleId": 10000, "roleName": "审批者", "userId": "21D62132-6570-4E63-9DCB-137CC35E7543", "userStatus": 1, "电子邮件": "[email protected]", “familyName”:“约翰逊”,“givenName”:“罗杰” } ], "记录数": 1, "页数": 1, "页数": 1}
您可以使用此 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 调用相同,允许按特定条件进行过滤。
您可以使用此 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 | 描述 |
---|---|
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 | 奇尔德雷
展开
相关应用
为您推荐
相关资讯
全部
|