From 2b94c85612efc274c5c164bb40a6b7f493a18597 Mon Sep 17 00:00:00 2001 From: github-actions Date: Fri, 13 Dec 2024 12:28:51 +0000 Subject: [PATCH] Update github page --- docs/api/index.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/index.html b/docs/api/index.html index 4e069e66..da898140 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -596,7 +596,7 @@

Request samples

Content type
application/json
{
  • "userRoleId": 0,
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

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>
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

Content type
application/json
{
  • "roleIdentifiers": [
    ],
  • "intendedAuthority": "SUPER_USER",
  • "sub": "string",
  • "email": "string",
  • "eduPersonPrincipalName": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "schacHomeOrganization": "string",
  • "guestRoleIncluded": true
}

Response samples

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",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastActivity": "2019-08-24T14:15:22Z",
  • "userRoles": [
    ],
  • "applications": [
    ],
  • "institution": {
    }
}

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

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "first": true,
  • "last": true,
  • "numberOfElements": 0,
  • "empty": true
}

byRole

Authorizations:
openId (openid) apiTokens
path Parameters
roleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "numberOfElements": 0,
  • "first": true,
  • "last": true,
  • "empty": true
}

byRole

Authorizations:
openId (openid) apiTokens
path Parameters
roleId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

managersByRole

Authorizations:
openId (openid) apiTokens
path Parameters
roleId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • "string"
]

consequencesDeleteRole

Authorizations:
openId (openid) apiTokens
path Parameters
roleId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

deleteUserRole

Authorizations:
openId (openid) apiTokens
path Parameters
id
required
integer <int64>
isGuest
required
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

expiryNotifications

Authorizations:
openId (openid)

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

cronCleanup

Authorizations:
openId (openid)

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

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

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "first": true,
  • "last": true,
  • "numberOfElements": 0,
  • "empty": true
}

updateRole

Authorizations:
openId (openid) apiTokens
Request Body schema: application/json
id
integer <int64>
name
required
string
shortName
required
string
description
string
urn
string
defaultExpiryDays
integer <int32>
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

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "numberOfElements": 0,
  • "first": true,
  • "last": true,
  • "empty": true
}

updateRole

Authorizations:
openId (openid) apiTokens
Request Body schema: application/json
id
integer <int64>
name
required
string
shortName
required
string
description
string
urn
string
defaultExpiryDays
integer <int32>
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

Content type
application/json
{
  • "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",
  • "inviterDisplayName": "string",
  • "userRoleCount": 0,
  • "applicationUsages": [
    ],
  • "auditable": {
    },
  • "applicationMaps": [
    ]
}

Response samples

Content type
application/json
{
  • "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",
  • "inviterDisplayName": "string",
  • "userRoleCount": 0,
  • "applicationUsages": [
    ],
  • "auditable": {
    },
  • "applicationMaps": [
    ]
}

newRole

Authorizations:
openId (openid) apiTokens
Request Body schema: application/json
id
integer <int64>
name
required
string
shortName
required
string
description
string
urn
string
defaultExpiryDays
integer <int32>
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

Content type
application/json
{
  • "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",
  • "inviterDisplayName": "string",
  • "userRoleCount": 0,
  • "applicationUsages": [
    ],
  • "auditable": {
    },
  • "applicationMaps": [
    ]
}

Response samples

Content type
application/json
{
  • "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",
  • "inviterDisplayName": "string",
  • "userRoleCount": 0,
  • "applicationUsages": [
    ],
  • "auditable": {
    },
  • "applicationMaps": [
    ]
}

role

Authorizations:
openId (openid) apiTokens
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "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",
  • "inviterDisplayName": "string",
  • "userRoleCount": 0,
  • "applicationUsages": [
    ],
  • "auditable": {
    },
  • "applicationMaps": [
    ]
}

deleteRole

Authorizations:
openId (openid) apiTokens
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

validation-controller

validate

Authorizations:
openId
Request Body schema: application/json
type
required
string
value
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

user-controller

error

Authorizations:
openId (openid) apiTokens
Request Body schema: application/json
property name*
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

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

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "first": true,
  • "last": true,
  • "numberOfElements": 0,
  • "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

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "first": true,
  • "last": true,
  • "numberOfElements": 0,
  • "empty": true
}

details

Authorizations:
openId (openid) apiTokens
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "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

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "pageable": {
    },
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "numberOfElements": 0,
  • "first": true,
  • "last": true,
  • "empty": true
}

details

Authorizations:
openId (openid) apiTokens
path Parameters
id
required
integer <int64>

Responses

Response samples

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",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastActivity": "2019-08-24T14:15:22Z",
  • "userRoles": [
    ],
  • "applications": [
    ],
  • "institution": {
    }
}

msAcceptReturn

Authorizations:
openId (openid) apiTokens
path Parameters
manageId
required
string
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "contentType": "string"
}

me

Authorizations:
openId (openid) apiTokens

Responses

Response samples

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",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastActivity": "2019-08-24T14:15:22Z",
  • "userRoles": [
    ],
  • "applications": [
    ],
  • "institution": {
    }
}

logout

Authorizations:
openId (openid) apiTokens

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "name": "string",
  • "data": [
    ]
}

attribute-aggregator-controller

getGroupMemberships_1

Authorizations:
basic_auth
path Parameters
unspecified_id
required
string
query Parameters
SPentityID
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]