diff --git a/docs/api/index.html b/docs/api/index.html index a8b0db15..9a715c2d 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -642,7 +642,7 @@
intendedAuthority required | string Enum: "SUPER_USER" "INSTITUTION_ADMIN" "MANAGER" "INVITER" "GUEST" |
message | string |
language | string Enum: "en" "nl" |
enforceEmailEquality | boolean |
eduIDOnly | boolean |
guestRoleIncluded | boolean |
suppressSendingEmails | boolean |
invites required | Array of strings |
roleIdentifiers | Array of integers <int64> |
roleExpiryDate | string <date-time> |
expiryDate required | string <date-time> |
{- "intendedAuthority": "INVITER",
- "message": "Personal message included in the email",
- "language": "en",
- "enforceEmailEquality": false,
- "eduIDOnly": false,
- "guestRoleIncluded": true,
- "suppressSendingEmails": false,
- "invites": [
- "admin@service.org"
], - "roleIdentifiers": [
- 99
], - "roleExpiryDate": 1760788376,
- "expiryDate": 1730461976
}
{- "status": 201,
- "recipientInvitationURLs": [
- {
- "recipient": "admin@service.nl",
}
]
}
{- "intendedAuthority": "INVITER",
- "message": "Personal message included in the email",
- "language": "en",
- "guestRoleIncluded": true,
- "invites": [
- "admin@service.org"
], - "roleIdentifiers": [
- 99
], - "roleExpiryDate": 1760788376,
- "expiryDate": 1730461976
}
{- "status": 201,
- "recipientInvitationURLs": [
- {
- "recipient": "admin@service.nl",
}
]
}
[- {
- "id": 0,
- "name": "string",
- "shortName": "string",
- "description": "string",
- "urn": "string",
- "defaultExpiryDays": 0,
- "enforceEmailEquality": true,
- "eduIDOnly": true,
- "blockExpiryDate": true,
- "overrideSettingsAllowed": true,
- "teamsOrigin": true,
- "identifier": "string",
- "organizationGUID": "string",
- "remoteApiUser": "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": { },
- "property2": { }
}
]
}
]
[- {
- "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",
- "createdAt": "2019-08-24T14:15:22Z",
- "lastActivity": "2019-08-24T14:15:22Z",
- "userRoles": [
- { }
], - "applications": [
- {
- "property1": { },
- "property2": { }
}
], - "institution": {
- "property1": { },
- "property2": { }
}
}, - "role": {
- "id": 0,
- "name": "string",
- "shortName": "string",
- "description": "string",
- "urn": "string",
- "defaultExpiryDays": 0,
- "enforceEmailEquality": true,
- "eduIDOnly": true,
- "blockExpiryDate": true,
- "overrideSettingsAllowed": true,
- "teamsOrigin": true,
- "identifier": "string",
- "organizationGUID": "string",
- "remoteApiUser": "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": { },
- "property2": { }
}
]
}, - "authority": "SUPER_USER",
- "userInfo": {
- "property1": { },
- "property2": { }
}
}
]
{- "status": "string",
- "name": "string",
- "data": [
- {
- "name": "string",
- "value": "string"
}
]
}