diff --git a/docs/api/index.html b/docs/api/index.html index ff9c54fa..f674c2d0 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -596,7 +596,7 @@
{- "userRoleId": 0,
- "endDate": "2019-08-24T14:15:22Z"
}
{- "property1": 0,
- "property2": 0
}
Provision the User if the User is unknown and add the Role(s)
roleIdentifiers required | Array of integers <int64> |
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 |
{- "roleIdentifiers": [
- 0
], - "intendedAuthority": "SUPER_USER",
- "sub": "string",
- "email": "string",
- "eduPersonPrincipalName": "string",
- "givenName": "string",
- "familyName": "string",
- "name": "string",
- "schacHomeOrganization": "string",
- "guestRoleIncluded": true
}
{- "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": [
- {
- "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,
- "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": { }
}
}
], - "applications": [
- {
- "property1": { },
- "property2": { }
}
], - "institution": {
- "property1": { },
- "property2": { }
}
}
roleId required | integer <int64> |
guests required | boolean |
query | string Default: "" |
pageNumber | integer <int32> Default: 0 |
pageSize | integer <int32> Default: 10 |
sort | string Default: "id" |
sortDirection | string Default: "ASC" |
{- "totalElements": 0,
- "totalPages": 0,
- "pageable": {
- "paged": true,
- "pageNumber": 0,
- "pageSize": 0,
- "offset": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "unpaged": true
}, - "size": 0,
- "content": [
- { }
], - "number": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "first": true,
- "last": true,
- "numberOfElements": 0,
- "empty": true
}
{- "totalElements": 0,
- "totalPages": 0,
- "pageable": {
- "paged": true,
- "pageNumber": 0,
- "pageSize": 0,
- "offset": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "unpaged": true
}, - "size": 0,
- "content": [
- { }
], - "number": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "numberOfElements": 0,
- "first": true,
- "last": true,
- "empty": true
}
[- {
- "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": { }
}
}
]
urn | string |
name | string |
description | string |
Array of objects (Membership) | |
Array of objects (Application) |
[- {
- "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": { }
}
]
}
]
query | string Default: "" |
pageNumber | integer <int32> Default: 0 |
pageSize | integer <int32> Default: 10 |
sort | string Default: "id" |
sortDirection | string Default: "ASC" |
{- "totalElements": 0,
- "totalPages": 0,
- "pageable": {
- "paged": true,
- "pageNumber": 0,
- "pageSize": 0,
- "offset": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "unpaged": true
}, - "size": 0,
- "content": [
- { }
], - "number": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "first": true,
- "last": true,
- "numberOfElements": 0,
- "empty": true
}
{- "totalElements": 0,
- "totalPages": 0,
- "pageable": {
- "paged": true,
- "pageNumber": 0,
- "pageSize": 0,
- "offset": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "unpaged": true
}, - "size": 0,
- "content": [
- { }
], - "number": 0,
- "sort": [
- {
- "direction": "string",
- "nullHandling": "string",
- "ascending": true,
- "property": "string",
- "ignoreCase": true
}
], - "numberOfElements": 0,
- "first": true,
- "last": true,
- "empty": true
}
[- {
- "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"
}
]
}
]
[- {
- "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": [
- {
- "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,
- "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": { }
}
}
], - "applications": [
- {
- "property1": { },
- "property2": { }
}
], - "institution": {
- "property1": { },
- "property2": { }
}
}
]
{- "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": [
- {
- "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,
- "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": { }
}
}
], - "applications": [
- {
- "property1": { },
- "property2": { }
}
], - "institution": {
- "property1": { },
- "property2": { }
}
}