Invite API (v1)

Download OpenAPI specification:Download

Invite external API endpoints

Authentication

openId

Security Scheme Type	OAuth2
authorizationCode OAuth Flow	Authorization URL: https://connect.test2.surfconext.nl/oidc/authorize Token URL: https://connect.test2.surfconext.nl/oidc/token Scopes: `openid` - openid

apiTokens

Security Scheme Type	API Key
Header parameter name:	X-API-TOKEN

basic_auth

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

user-role-controller

updateUserRoleExpirationDate

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

userRoleId required	integer <int64>
endDate	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"userRoleId": 0,
"endDate": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"property1": 0,
"property2": 0
}

Add Role to a User

Provision the User if the User is unknown and add the Role(s)

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

roleIdentifiers required	Array of integers <int64> non-empty
intendedAuthority	string Enum: "SUPER_USER" "INSTITUTION_ADMIN" "MANAGER" "INVITER" "GUEST"
sub	string
email required	string
eduPersonPrincipalName	string
givenName	string
familyName	string
name	string
schacHomeOrganization	string
guestRoleIncluded	boolean

Responses

Request samples

Payload

Content type

application/json

{"roleIdentifiers": [0
],
"intendedAuthority": "SUPER_USER",
"sub": "string",
"email": "string",
"eduPersonPrincipalName": "string",
"givenName": "string",
"familyName": "string",
"name": "string",
"schacHomeOrganization": "string",
"guestRoleIncluded": true
}

Response samples

200

Content type

application/json

{"id": 0,
"sub": "string",
"superUser": true,
"eduPersonPrincipalName": "string",
"givenName": "string",
"familyName": "string",
"name": "string",
"subjectId": "string",
"eduId": "string",
"uid": "string",
"schacHomeOrganization": "string",
"organizationGUID": "string",
"institutionAdmin": true,
"institutionAdminByInvite": true,
"email": "string",
"internalPlaceholderIdentifier": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastActivity": "2019-08-24T14:15:22Z",
"userRoles": [{"id": 0,
"inviter": "string",
"endDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"expiryNotifications": 0,
"guestRoleIncluded": true,
"user": { },
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
},
"authority": "SUPER_USER",
"userInfo": {"property1": null,
"property2": null
}
}
],
"applications": [{"property1": null,
"property2": null
}
],
"institution": {"property1": null,
"property2": null
}
}

searchPaginated

Authorizations:

openId (openid) apiTokens

path Parameters

roleId required	integer <int64>
guests required	boolean

query Parameters

query	string Default: ""
pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sort	string Default: "name"
sortDirection	string Default: "ASC"

Responses

Response samples

200

Content type

application/json

{"totalElements": 0,
"totalPages": 0,
"pageable": {"paged": true,
"pageNumber": 0,
"pageSize": 0,
"offset": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"content": [null
],
"number": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

byRole

Authorizations:

openId (openid) apiTokens

path Parameters

roleId

required

integer <int64>

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"inviter": "string",
"endDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"expiryNotifications": 0,
"guestRoleIncluded": true,
"user": {"id": 0,
"sub": "string",
"superUser": true,
"eduPersonPrincipalName": "string",
"givenName": "string",
"familyName": "string",
"name": "string",
"subjectId": "string",
"eduId": "string",
"uid": "string",
"schacHomeOrganization": "string",
"organizationGUID": "string",
"institutionAdmin": true,
"institutionAdminByInvite": true,
"email": "string",
"internalPlaceholderIdentifier": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastActivity": "2019-08-24T14:15:22Z",
"userRoles": [{ }
],
"applications": [{"property1": null,
"property2": null
}
],
"institution": {"property1": null,
"property2": null
}
},
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
},
"authority": "SUPER_USER",
"userInfo": {"property1": null,
"property2": null
}
}
]

managersByRole

Authorizations:

openId (openid) apiTokens

path Parameters

roleId

required

integer <int64>

Responses

Response samples

200

Content type

application/json

["string"
]

consequencesDeleteRole

Authorizations:

openId (openid) apiTokens

path Parameters

roleId

required

integer <int64>

Responses

Response samples

200

Content type

application/json

[{"property1": null,
"property2": null
}
]

deleteUserRole

Authorizations:

openId (openid) apiTokens

path Parameters

id required	integer <int64>
isGuest required	boolean

Responses

teams-controller

migrateTeam

Authorizations:

basic_auth

Request Body schema: application/json

urn	string
name	string
description	string
	Array of objects (Membership)
	Array of objects (Application)

Responses

Request samples

Payload

Content type

application/json

{"urn": "string",
"name": "string",
"description": "string",
"memberships": [{"person": {"urn": "string",
"name": "string",
"email": "string",
"schacHomeOrganization": "string",
"created": "2019-08-24T14:15:22Z"
},
"role": "MEMBER",
"created": "2019-08-24T14:15:22Z"
}
],
"applications": [{"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
]
}

Response samples

200

Content type

application/json

{"property1": 0,
"property2": 0
}

system-controller

performanceSeed

Authorizations:

openId (openid)

query Parameters

numberOfRole	integer <int32> Default: 500
numberOfUsers	integer <int32> Default: 75000

Responses

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

unknownRoles

Authorizations:

openId (openid)

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}
]

expiryUserRoles

Authorizations:

openId (openid)

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"inviter": "string",
"endDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"expiryNotifications": 0,
"guestRoleIncluded": true,
"user": {"id": 0,
"sub": "string",
"superUser": true,
"eduPersonPrincipalName": "string",
"givenName": "string",
"familyName": "string",
"name": "string",
"subjectId": "string",
"eduId": "string",
"uid": "string",
"schacHomeOrganization": "string",
"organizationGUID": "string",
"institutionAdmin": true,
"institutionAdminByInvite": true,
"email": "string",
"internalPlaceholderIdentifier": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastActivity": "2019-08-24T14:15:22Z",
"userRoles": [{ }
],
"applications": [{"property1": null,
"property2": null
}
],
"institution": {"property1": null,
"property2": null
}
},
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
},
"authority": "SUPER_USER",
"userInfo": {"property1": null,
"property2": null
}
}
]

expiryNotifications

Authorizations:

openId (openid)

Responses

Response samples

200

Content type

application/json

{"property1": ["string"
],
"property2": ["string"
]
}

cronCleanup

Authorizations:

openId (openid)

Responses

Response samples

200

Content type

application/json

{"property1": [null
],
"property2": [null
]
}

role-controller

rolesByApplication

Authorizations:

openId (openid) apiTokens

query Parameters

force	boolean Default: true
query	string Default: ""
pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sort	string Default: "name"
sortDirection	string Default: "ASC"

Responses

Response samples

200

Content type

application/json

{"totalElements": 0,
"totalPages": 0,
"pageable": {"paged": true,
"pageNumber": 0,
"pageSize": 0,
"offset": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"content": [{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}
],
"number": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

updateRole

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

id	integer <int64>
name required	string non-empty
shortName	string
description	string
urn	string
defaultExpiryDays	integer <int32>
defaultExpiryDate	string <date-time>
enforceEmailEquality	boolean
eduIDOnly	boolean
blockExpiryDate	boolean
overrideSettingsAllowed	boolean
teamsOrigin	boolean
identifier	string
organizationGUID	string
remoteApiUser	string
inviterDisplayName	string
userRoleCount	integer <int64>
	Array of objects (ApplicationUsage) unique
	object (Auditable)
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}

newRole

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

name required	string non-empty
description	string
defaultExpiryDays	integer <int32>
defaultExpiryDate	string <date-time>
enforceEmailEquality	boolean
eduIDOnly	boolean
blockExpiryDate	boolean
overrideSettingsAllowed	boolean
organizationGUID	string
inviterDisplayName	string
	Array of objects (ApplicationUsage) unique

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"organizationGUID": "string",
"inviterDisplayName": "string",
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}

role

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

integer <int64>

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}

deleteRole

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

integer <int64>

Responses

rolesPerApplicationId

Authorizations:

openId (openid) apiTokens

path Parameters

manageId

required

string

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}
]

invitation-controller

resendInvitation

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

integer <int64>

Responses

Response samples

200

Content type

application/json

{"property1": 0,
"property2": 0
}

deleteInvitation

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

integer <int64>

Responses

accept

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

hash	string
invitationId	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"hash": "string",
"invitationId": 0
}

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Invite member for existing Role

Invite a member for an existing role. An invitation email will be sent. Do not forget to set guestRoleIncluded to true. At least one email must be either present in invites or invitesWithInternalPlaceholderIdentifiers. When using the invitations you can also specify the internalPlaceholderIdentifier, which will be used as the id in the SCIM POST to /User.

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

intendedAuthority required	string Enum: "SUPER_USER" "INSTITUTION_ADMIN" "MANAGER" "INVITER" "GUEST"
message	string
language	string Enum: "en" "nl"
enforceEmailEquality	boolean
eduIDOnly	boolean
requestedAuthnContext	string Enum: "EduIDLinkedInstitution" "EduIDValidatedName" "ValidateNamesExternal" "EduIDRequireStudentAffiliation" "TransparentAuthnContext"
guestRoleIncluded	boolean
suppressSendingEmails	boolean
invites	Array of strings
	Array of objects (Invite)
roleIdentifiers	Array of integers <int64>
organizationGUID	string
roleExpiryDate	string <date-time>
expiryDate required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"intendedAuthority": "INVITER",
"message": "Personal message included in the email",
"language": "en",
"guestRoleIncluded": true,
"invites": ["admin@service.org"
],
"invitesWithInternalPlaceholderIdentifiers": [{"email": "admin2@service.org",
"internalPlaceholderIdentifier": "4EFF937F-EE78-4A54-9FD8-A214FD64D7E1"
}
],
"roleIdentifiers": [99
],
"roleExpiryDate": 1760788376,
"expiryDate": 1730461976
}

Response samples

201
400
404

Content type

application/json

{"status": 201,
"recipientInvitationURLs": [{"recipient": "admin@service.nl",
"invitationURL": "https://invite.test.surfconext.nl/invitation/accept?{hash}"
}
]
}

search_1

Authorizations:

openId (openid) apiTokens

query Parameters

roleId	integer <int64>
query	string Default: ""
pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sort	string Default: "name"
sortDirection	string Default: "ASC"

Responses

Response samples

200

Content type

application/json

{"totalElements": 0,
"totalPages": 0,
"pageable": {"paged": true,
"pageNumber": 0,
"pageSize": 0,
"offset": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"content": [{"property1": null,
"property2": null
}
],
"number": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

byRole_1

Authorizations:

openId (openid) apiTokens

path Parameters

roleId

required

integer <int64>

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"intendedAuthority": "SUPER_USER",
"language": "en",
"status": "OPEN",
"email": "string",
"message": "string",
"subInvitee": "string",
"enforceEmailEquality": true,
"eduIDOnly": true,
"requestedAuthnContext": "EduIDLinkedInstitution",
"guestRoleIncluded": true,
"createdAt": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"roleExpiryDate": "2019-08-24T14:15:22Z",
"acceptedAt": "2019-08-24T14:15:22Z",
"organizationGUID": "string",
"internalPlaceholderIdentifier": "string",
"remoteApiUser": "string",
"roles": [{"id": 0,
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}
}
],
"emailEqualityConflict": true,
"inviter": {"property1": null,
"property2": null
}
}
]

getInvitation

Authorizations:

openId (openid) apiTokens

query Parameters

hash

required

string

Responses

Response samples

200

Content type

application/json

{"id": 0,
"intendedAuthority": "SUPER_USER",
"language": "en",
"status": "OPEN",
"email": "string",
"message": "string",
"subInvitee": "string",
"enforceEmailEquality": true,
"eduIDOnly": true,
"requestedAuthnContext": "EduIDLinkedInstitution",
"guestRoleIncluded": true,
"createdAt": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"roleExpiryDate": "2019-08-24T14:15:22Z",
"acceptedAt": "2019-08-24T14:15:22Z",
"organizationGUID": "string",
"internalPlaceholderIdentifier": "string",
"remoteApiUser": "string",
"roles": [{"id": 0,
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}
}
],
"emailEqualityConflict": true,
"inviter": {"property1": null,
"property2": null
}
}

all

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"intendedAuthority": "SUPER_USER",
"language": "en",
"status": "OPEN",
"email": "string",
"message": "string",
"subInvitee": "string",
"enforceEmailEquality": true,
"eduIDOnly": true,
"requestedAuthnContext": "EduIDLinkedInstitution",
"guestRoleIncluded": true,
"createdAt": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"roleExpiryDate": "2019-08-24T14:15:22Z",
"acceptedAt": "2019-08-24T14:15:22Z",
"organizationGUID": "string",
"internalPlaceholderIdentifier": "string",
"remoteApiUser": "string",
"roles": [{"id": 0,
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
}
}
],
"emailEqualityConflict": true,
"inviter": {"property1": null,
"property2": null
}
}
]

validation-controller

validate

Authorizations:

openId

Request Body schema: application/json

type required	string
value required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"value": "string"
}

Response samples

200

Content type

application/json

{"property1": true,
"property2": true
}

user-controller

error

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

property name*

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200

Content type

application/json

{"property1": 0,
"property2": 0
}

searchByApplication

Authorizations:

openId (openid) apiTokens

query Parameters

query	string Default: ""
pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sort	string Default: "name"
sortDirection	string Default: "ASC"

Responses

Response samples

200

Content type

application/json

{"totalElements": 0,
"totalPages": 0,
"pageable": {"paged": true,
"pageNumber": 0,
"pageSize": 0,
"offset": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"content": [{"id": 0,
"name": "string",
"email": "string",
"schacHomeOrganization": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastActivity": "2019-08-24T14:15:22Z",
"roleSummaries": [{"id": 0,
"roleName": "string",
"authority": "string",
"endDate": "2019-08-24T14:15:22Z"
}
]
}
],
"number": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

search

Authorizations:

openId (openid) apiTokens

query Parameters

force	boolean Default: true
query	string Default: ""
pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sort	string Default: "name"
sortDirection	string Default: "ASC"

Responses

Response samples

200

Content type

application/json

{"totalElements": 0,
"totalPages": 0,
"pageable": {"paged": true,
"pageNumber": 0,
"pageSize": 0,
"offset": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"content": [{"property1": null,
"property2": null
}
],
"number": 0,
"sort": {"sorted": true,
"empty": true,
"unsorted": true
},
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

details

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

integer <int64>

Responses

Response samples

200

Content type

application/json

{"id": 0,
"sub": "string",
"superUser": true,
"eduPersonPrincipalName": "string",
"givenName": "string",
"familyName": "string",
"name": "string",
"subjectId": "string",
"eduId": "string",
"uid": "string",
"schacHomeOrganization": "string",
"organizationGUID": "string",
"institutionAdmin": true,
"institutionAdminByInvite": true,
"email": "string",
"internalPlaceholderIdentifier": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastActivity": "2019-08-24T14:15:22Z",
"userRoles": [{"id": 0,
"inviter": "string",
"endDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"expiryNotifications": 0,
"guestRoleIncluded": true,
"user": { },
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
},
"authority": "SUPER_USER",
"userInfo": {"property1": null,
"property2": null
}
}
],
"applications": [{"property1": null,
"property2": null
}
],
"institution": {"property1": null,
"property2": null
}
}

msAcceptReturn

Authorizations:

openId (openid) apiTokens

path Parameters

manageId required	string
userId required	integer <int64>

Responses

Response samples

200

Content type

application/json

{"contentType": "string"
}

me

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

{"id": 0,
"sub": "string",
"superUser": true,
"eduPersonPrincipalName": "string",
"givenName": "string",
"familyName": "string",
"name": "string",
"subjectId": "string",
"eduId": "string",
"uid": "string",
"schacHomeOrganization": "string",
"organizationGUID": "string",
"institutionAdmin": true,
"institutionAdminByInvite": true,
"email": "string",
"internalPlaceholderIdentifier": "string",
"createdAt": "2019-08-24T14:15:22Z",
"lastActivity": "2019-08-24T14:15:22Z",
"userRoles": [{"id": 0,
"inviter": "string",
"endDate": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"expiryNotifications": 0,
"guestRoleIncluded": true,
"user": { },
"role": {"id": 0,
"name": "string",
"shortName": "string",
"description": "string",
"urn": "string",
"defaultExpiryDays": 0,
"defaultExpiryDate": "2019-08-24T14:15:22Z",
"enforceEmailEquality": true,
"eduIDOnly": true,
"blockExpiryDate": true,
"overrideSettingsAllowed": true,
"teamsOrigin": true,
"identifier": "string",
"organizationGUID": "string",
"remoteApiUser": "string",
"inviterDisplayName": "string",
"userRoleCount": 0,
"applicationUsages": [{"id": 0,
"landingPage": "string",
"application": {"id": 0,
"manageId": "string",
"manageType": "SAML20_SP",
"landingPage": "string"
}
}
],
"auditable": {"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"applicationMaps": [{"property1": null,
"property2": null
}
]
},
"authority": "SUPER_USER",
"userInfo": {"property1": null,
"property2": null
}
}
],
"applications": [{"property1": null,
"property2": null
}
],
"institution": {"property1": null,
"property2": null
}
}

logout

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

{"property1": 0,
"property2": 0
}

login

Authorizations:

openId (openid) apiTokens

query Parameters

app	string Default: "client"

Responses

Response samples

200

Content type

application/json

{"contentType": "string"
}

config

Authorizations:

openId (openid) apiTokens

query Parameters

required	object (User)
guest	boolean Default: false

Responses

Response samples

200

Content type

application/json

{"clientUrl": "string",
"welcomeUrl": "string",
"serverUrl": "string",
"serverWelcomeUrl": "string",
"eduidEntityId": "string",
"roleSearchRequired": true,
"pastDateAllowed": true,
"performanceSeedAllowed": true,
"groupUrnPrefix": "string",
"authenticated": true,
"name": "string",
"eduidIdpSchacHomeOrganization": "string",
"missingAttributes": ["string"
],
"languages": "string"
}

delete

Authorizations:

openId (openid) apiTokens

path Parameters

userId

required

integer <int64>

Responses

api-token-controller

apiTokensByInstitution

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"organizationGUID": "string",
"superUserToken": true,
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"owner": "string"
}
]

create

Authorizations:

openId (openid) apiTokens

Request Body schema: application/json

id	integer <int64>
organizationGUID	string
hashedValue	string
superUserToken	boolean
description required	string non-empty
createdAt	string <date-time>
owner	string

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"organizationGUID": "string",
"hashedValue": "string",
"superUserToken": true,
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"owner": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"organizationGUID": "string",
"superUserToken": true,
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"owner": "string"
}

generateToken

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

{"property1": "string",
"property2": "string"
}

deleteToken

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

integer <int64>

Responses

internal-invite-controller

Create a Role

Create a Role linked to a SP in Manage. Note that the required application object needs to be pre-configured during deployment.

Authorizations:

basic_auth

Request Body schema: application/json

name required	string non-empty
description	string
defaultExpiryDays	integer <int32>
defaultExpiryDate	string <date-time>
enforceEmailEquality	boolean
eduIDOnly	boolean
blockExpiryDate	boolean
overrideSettingsAllowed	boolean
organizationGUID	string
inviterDisplayName	string
	Array of objects (ApplicationUsage) unique

Responses

Request samples

Payload

Content type

application/json

"{\n  \"name\": \"Required role name\",\n  \"description\": \"Required role description\",\n  \"defaultExpiryDays\": 365,\n  \"inviterDisplayName\": \"Free format field used in the invitation emails for this role (can be email address)\"\n  \"applicationUsages\": [\n    {\n      \"landingPage\": \"https://landingpage.com\",\n      \"application\": {\n        \"manageId\": \"4\",\n        \"manageType\": \"SAML20_SP\"\n      }\n    }\n  ]\n}\n"

Response samples

201
400

Content type

application/json

{"id": 42114,
"name": "Required role name",
"shortName": "required_role_name",
"description": "Required role description",
"urn": "urn:mace:surf.nl:test.surfaccess.nl:74fd8059-7558-4454-8393-fd84f74c4907:required_role_name",
"defaultExpiryDays": 365,
"enforceEmailEquality": false,
"eduIDOnly": false,
"blockExpiryDate": false,
"overrideSettingsAllowed": false,
"teamsOrigin": false,
"identifier": "74fd8059-7558-4454-8393-fd84f74c4907",
"remoteApiUser": "SP Dashboard",
"applicationUsages": [{"id": 49203,
"landingPage": "http://landingpage.com",
"application": {"id": 41904,
"manageId": "4",
"manageType": "SAML20_SP"
}
}
],
"auditable": {"createdAt": 1729254283,
"createdBy": "sp_dashboard"
},
"applicationMaps": [{"OrganizationName:en": "SURF bv",
"landingPage": "http://landingpage.com",
"logo": "https://static.surfconext.nl/media/idp/surfconext.png",
"entityid": "https://research",
"name:en": "Research EN",
"id": "4",
"_id": "4",
"type": "saml20_sp",
"url": "https://default-url-research.org",
"name:nl": "Research NL"
}
]
}

Invite member for existing Role

Invite a member for an existing role. An invitation email will be sent. Do not forget to set guestRoleIncluded to true.At least one email must be either present in invites or invitations. When using the invitations you can also specify the internalPlaceholderIdentifier, which will be used as the id in the SCIM POST to /User.

Authorizations:

basic_auth

Request Body schema: application/json

intendedAuthority required	string Enum: "SUPER_USER" "INSTITUTION_ADMIN" "MANAGER" "INVITER" "GUEST"
message	string
language	string Enum: "en" "nl"
enforceEmailEquality	boolean
eduIDOnly	boolean
requestedAuthnContext	string Enum: "EduIDLinkedInstitution" "EduIDValidatedName" "ValidateNamesExternal" "EduIDRequireStudentAffiliation" "TransparentAuthnContext"
guestRoleIncluded	boolean
suppressSendingEmails	boolean
invites	Array of strings
	Array of objects (Invite)
roleIdentifiers	Array of integers <int64>
organizationGUID	string
roleExpiryDate	string <date-time>
expiryDate required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

Invitation example

"{\n  \"intendedAuthority\": \"INVITER\",\n  \"message\": \"Personal message included in the email\",\n  \"language\": \"en\",\n  \"guestRoleIncluded\": true,\n  \"invites\": [\n    \"admin@service.org\"\n  ],\n  \"invitations\": [{\n    \"email\": \"admin2@service.org\",\n    \"internalPlaceholderIdentifier\": \"4EFF937F-EE78-4A54-9FD8-A214FD64D7E1\",\n  }],\n  \"roleIdentifiers\": [\n    99\n  ],\n  \"roleExpiryDate\": 1760788376,\n  \"expiryDate\": 1730461976\n}\n"

Response samples

201
400
404

Content type

application/json

{"status": 201,
"recipientInvitationURLs": [{"recipient": "admin@service.nl",
"invitationURL": "https://invite.test.surfconext.nl/invitation/accept?{hash}"
}
]
}

Delete existing Role

Delete an existing role. The path parameter id is the id returned when creating the role.

Authorizations:

basic_auth

path Parameters

id

required

integer <int64>

Unique database id of the role

Responses

Response samples

400
404

Content type

application/json

{"timestamp": 1717672263253,
"status": 400,
"error": "BadRequest",
"exception": "access.exception.UserRestrictionException",
"message": "No access to role",
"path": "/api/internal/roles/999"
}

voot-controller

getGroupMemberships

Authorizations:

basic_auth

path Parameters

unspecified_id

required

string

Responses

Response samples

200

Content type

application/json

[{"property1": "string",
"property2": "string"
}
]

profile-controller

roles

Authorizations:

basic_auth

query Parameters

collabPersonId

required

string

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"description": "string",
"applications": [{"landingPage": "string",
"nameEn": "string",
"nameNl": "string",
"organisationEn": "string",
"organisationNl": "string",
"logo": "string"
}
]
}
]

manage-controller

requestedAuthnContextValues

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

{"property1": "string",
"property2": "string"
}

provisionings

Authorizations:

openId (openid) apiTokens

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

true

providers

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

[{"property1": null,
"property2": null
}
]

providerById

Authorizations:

openId (openid) apiTokens

path Parameters

type required	string Enum: "SAML20_SP" "OIDC10_RP" "SAML20_IDP" "PROVISIONING"
id required	string

Responses

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

organizationGUIDValidation

Authorizations:

openId (openid) apiTokens

path Parameters

organizationGUID

required

string

Responses

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

identityProviders

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

[{"property1": null,
"property2": null
}
]

eduIDIdentityProvider

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

applications

Authorizations:

openId (openid) apiTokens

Responses

Response samples

200

Content type

application/json

{"property1": [{"property1": null,
"property2": null
}
],
"property2": [{"property1": null,
"property2": null
}
]
}

user-life-cycle-controller

preview

Authorizations:

basic_auth

path Parameters

userId

required

string

Responses

Response samples

200

Content type

application/json

{"status": "string",
"name": "string",
"data": [{"name": "string",
"value": "string"
}
]
}

deprovision

Authorizations:

basic_auth

path Parameters

userId

required

string

Responses

Response samples

200

Content type

application/json

{"status": "string",
"name": "string",
"data": [{"name": "string",
"value": "string"
}
]
}

dryRun

Authorizations:

basic_auth

path Parameters

userId

required

string

Responses

Response samples

200

Content type

application/json

{"status": "string",
"name": "string",
"data": [{"name": "string",
"value": "string"
}
]
}

attribute-aggregator-controller

getGroupMemberships_1

Authorizations:

basic_auth

path Parameters

unspecified_id

required

string

query Parameters

SPentityID

required

string

Responses

Response samples

200

Content type

application/json

[{"property1": "string",
"property2": "string"
}
]