Identity API

• getResetPassword
• getGetUsers
• getAddQRCode
• getGenerateQRCode
• getSSOApplications
• postCreateLogin
• postCreateUser

API docs by Redocly

Xporter Identity (1.0.0)

Download OpenAPI specification:Download

Xporter Identity API

ResetPassword

Performs a password reset on an existing user.

Requires authorisation with a school secret. The specified user must exist within the authenticated establishment

Authorizations:

IdaasSTSToken

query Parameters

username required	string Username of the existing user
password	string Password to use (optional - one will be generated if omitted)
ChangeAtNextLogin	boolean Force password reset on next login
UnlockLogin	boolean Unlock login if currently locked

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/Identity/ResetPassword

https://xporter.groupcall.com/Identity/ResetPassword

Response samples

• 200
• default

Content type

application/json

{

• "Success": true,
• "Password": "string"

}

GetUsers

Retreive a list of users for the authenticated establishment

Authorizations:

IdaasSTSToken

query Parameters

presenceType

string Enum: "Learners" "Teach" "NonTeach" Type of presence to return

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/Identity/GetUsers

https://xporter.groupcall.com/Identity/GetUsers

Response samples

• 200

Content type

application/json

[

• {

  • "Id": "string",
  • "DisplayName": "string",
  • "FirstName": "string",
  • "Surname": "string",
  • "LastLoggedIn": "string",
  • "UserName": "string",
  • "Roles": "string",
  • "PresenceType": "string",
  • "WorkEmail": "string",
  • "Email": "string"

  }

]

AddQRCode

Add a QRCode for a user - allows user to login with a QR code in addition to username and password

Authorizations:

IdaasSTSToken

query Parameters

username required	string
expires required	string Example: expires=2025-07-20 QR expiry date

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/identity/AddQRCode

https://xporter.groupcall.com/identity/AddQRCode

GenerateQRCode

Generates QR code images with custom payload. Authenticated with a Management secret

Authorizations:

IdaasSTSToken

query Parameters

text required	string payload
centerImagePercent	number Center image percentage size
centerImageUrl	string publicly accessible URL for center/background image
QRType	string QR code type - QRCode for standard, ArtCode for "artistic" codes

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/Identity/GenerateQRCode

https://xporter.groupcall.com/Identity/GenerateQRCode

SSOApplications

Authorizations:

IdaasSTSToken

query Parameters

estab	string
email	string
includesuggested	boolean

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/Identity/SSOApplications

https://xporter.groupcall.com/Identity/SSOApplications

CreateLogin

Create a login for an existing presence ands sends a registration email to the workemail address of the presence.

Authenticated with a school secret. Presence must be a member of the authenticated establishment

Authorizations:

IdaasSTSToken

query Parameters

OrgId required	string Estab local id
PresenceId required	string Presence local id

Request Body schema: application/json

OrgId	string
PresenceId	string

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/identity/CreateLogin

https://xporter.groupcall.com/identity/CreateLogin

Request samples

• Payload

Content type

application/json

{

• "OrgId": "string",
• "PresenceId": "string"

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "displayName": "string",
  • "firstName": "string",
  • "surname": "string",
  • "lastLoggedIn": "string",
  • "userName": "string",
  • "roles": "string",
  • "presenceType": "string",
  • "workEmail": "string",
  • "email": "string"

  }

]

CreateUser

Create a manual presence with login and sends registration email to user

Authorizations:

IdaasSTSToken

Request Body schema: application/json

orgId	string
partnerId	string
	Array of objects
authProcessFlow	boolean

Responses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/CommunityBrands/XporterIdentity/1.0.0/identity/CreateUser

https://xporter.groupcall.com/identity/CreateUser

Request samples

• Payload

Content type

application/json

{

• "orgId": "string",
• "partnerId": "string",
• "manualUser": [

  • {

    • "title": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "displayName": "string",
    • "email": "string",
    • "mobile": "string"

    }

  ],
• "authProcessFlow": true

}

Response samples

• 200

Content type

application/json

{

• "manualUser": [

  • {

    • "title": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "displayName": "string",
    • "email": "string",
    • "mobile": "string"

    }

  ]

}