From c00895ff2b8e59f167e1b36d4daa8efaf5dff8ca Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 6 Nov 2024 13:09:51 +0000 Subject: [PATCH] Update github page --- docs/api/index.html | 46 ++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/docs/api/index.html b/docs/api/index.html index 729efe2e..de3e8129 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -572,7 +572,7 @@ -
Documentation Powered by ReDoc
Documentation Powered by ReDoc

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_1

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: "id"
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
[
  • {
    }
]

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

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

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
}

searchPaginated

Authorizations:
openId (openid) apiTokens
query Parameters
query
string
Default: ""
pageNumber
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 10
sort
string
Default: "id"
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
}

searchByApplication

Authorizations:
openId (openid) apiTokens
query Parameters
query
required
string

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
}

searchByApplication

Authorizations:
openId (openid) apiTokens
query Parameters
query
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search

Authorizations:
openId (openid) apiTokens
query Parameters
query
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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
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
userRoleCount
integer <int64>
Array of objects (ApplicationUsage) unique
object (Auditable)
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "Required role name",
  • "shortName": "Required short name - may be copy of name",
  • "description": "Required role description",
  • "defaultExpiryDays": 365,
  • "applicationUsages": []
}

Response samples

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": [
    ],
  • "auditable": {
    },
  • "applicationMaps": []
}

Invite member for existing Role

Invite a member for an existing role. An invitation email will be sent. Do not forget to set to

+

Request samples

Content type
application/json
{
  • "name": "Required role name",
  • "shortName": "Required short name - may be copy of name",
  • "description": "Required role description",
  • "defaultExpiryDays": 365,
  • "applicationUsages": []
}

Response samples

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": [
    ],
  • "auditable": {
    },
  • "applicationMaps": []
}

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.

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
guestRoleIncluded
boolean
suppressSendingEmails
boolean
invites
required
Array of strings
roleIdentifiers
Array of integers <int64>
roleExpiryDate
string <date-time>
expiryDate
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "intendedAuthority": "INVITER",
  • "message": "Personal message included in the email",
  • "language": "en",
  • "guestRoleIncluded": true,
  • "invites": [
    ],
  • "roleIdentifiers": [
    ],
  • "roleExpiryDate": 1760788376,
  • "expiryDate": 1730461976
}

Response samples

Content type
application/json
{}

deleteRole_1

Authorizations:
basic_auth
path Parameters
id
required
integer <int64>

Responses

voot-controller

getGroupMemberships

Authorizations:
basic_auth
path Parameters
unspecified_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

system-controller

unknownRoles

Authorizations:
openId (openid)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

expiryUserRoles

Authorizations:
openId (openid)

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": [
    ]
}

profile-controller

roles

Authorizations:
basic_auth
query Parameters
collabPersonId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

manage-controller

providers

Authorizations:
openId (openid) apiTokens

Responses

Response samples

Content type
application/json
[
  • {
    }
]

providerById

Authorizations:
openId (openid) apiTokens
path Parameters
type
required
string
Enum: "SAML20_SP" "OIDC10_RP" "SAML20_IDP" "PROVISIONING"
id
required
string

Responses

Response samples

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

organizationGUIDValidation

Authorizations:
openId (openid) apiTokens
path Parameters
organizationGUID
required
string

Responses

Response samples

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

applications

Authorizations:
openId (openid) apiTokens

Responses

Response samples

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

user-life-cycle-controller

preview

Authorizations:
basic_auth
path Parameters
userId
required
string

Responses

Response samples

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

deprovision

Authorizations:
basic_auth
path Parameters
userId
required
string

Responses

Response samples

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

dryRun

Authorizations:
basic_auth
path Parameters
userId
required
string

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
[
  • {
    }
]
+

Request samples

Content type
application/json
{
  • "intendedAuthority": "INVITER",
  • "message": "Personal message included in the email",
  • "language": "en",
  • "guestRoleIncluded": true,
  • "invites": [
    ],
  • "roleIdentifiers": [
    ],
  • "roleExpiryDate": 1760788376,
  • "expiryDate": 1730461976
}

Response samples

Content type
application/json
{}

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

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

Content type
application/json
[
  • {
    }
]

system-controller

unknownRoles

Authorizations:
openId (openid)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

expiryUserRoles

Authorizations:
openId (openid)

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": [
    ]
}

profile-controller

roles

Authorizations:
basic_auth
query Parameters
collabPersonId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

manage-controller

providers

Authorizations:
openId (openid) apiTokens

Responses

Response samples

Content type
application/json
[
  • {
    }
]

providerById

Authorizations:
openId (openid) apiTokens
path Parameters
type
required
string
Enum: "SAML20_SP" "OIDC10_RP" "SAML20_IDP" "PROVISIONING"
id
required
string

Responses

Response samples

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

organizationGUIDValidation

Authorizations:
openId (openid) apiTokens
path Parameters
organizationGUID
required
string

Responses

Response samples

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

applications

Authorizations:
openId (openid) apiTokens

Responses

Response samples

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

user-life-cycle-controller

preview

Authorizations:
basic_auth
path Parameters
userId
required
string

Responses

Response samples

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

deprovision

Authorizations:
basic_auth
path Parameters
userId
required
string

Responses

Response samples

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

dryRun

Authorizations:
basic_auth
path Parameters
userId
required
string

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
[
  • {
    }
]