AuthenticationResource
Authentication Resource. This can be used to authenticate an existing SID.
The following resources are part of this group:
- /auth/globalprefix
- /auth/hashpassword
- /auth/login
- /auth/loginwithrsa
- /auth/matchpassword
- /auth/ssologin
- /auth/logout/{sid}
- /auth/validate/{sid}
/auth/globalprefix
Mount Point: /CNPortletapp/rest/auth/globalprefix
GET
Returns the global prefix
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
GenericResponse
/auth/hashpassword
Mount Point: /CNPortletapp/rest/auth/hashpassword
POST
Create a hash of the given password and userID The hashing algorithm can change at any time. As this method is possibly expensive (depends on the implemented hash algorithm), we don't allow anonymous access to it.
Parameters
name | description | type | default |
---|---|---|---|
sid | (no documentation provided) | query | 0 |
Request Body
element: | hashPasswordRequest |
media types: | */* application/xml application/json |
Password request object
Response Body
element: | hashPasswordResponse |
media types: | */* application/xml application/json |
HashPasswordResponse
/auth/login
Mount Point: /CNPortletapp/rest/auth/login
GET
Perform a login to the system with SSO systems
Response Body
element: | (custom) |
media types: | text/plain |
SID or "NOTFOUND" or "FAILURE"
POST
Perform a login to the system based on user credentials. If the user is successfully authenticated, create a new session and send back the sid. If a new sessionSecret is created, set it as a cookie
Parameters
name | description | type | default |
---|---|---|---|
sid | Optional: Existing sid number, the stored secret must match the cookie | query | 0 |
Request Body
element: | loginRequest |
media types: | */* application/xml application/json |
login request (contains the login credentials)
Response Body
element: | loginResponse |
media types: | */* application/xml application/json |
login response
/auth/loginwithrsa
Mount Point: /CNPortletapp/rest/auth/loginwithrsa
POST
Perform a login to the system based on RSA signature. If the user is successfully authenticated, create a new session and send back the sid. If a new sessionSecret is created, set it as a cookie.
Parameters
name | description | type | default |
---|---|---|---|
sid | Optional: Existing sid number, the stored secret must match the cookie | query | 0 |
Request Body
element: | loginWithRsaRequest |
media types: | */* application/xml application/json |
login request (contains the login credentials)
Response Body
element: | loginResponse |
media types: | */* application/xml application/json |
login response
/auth/matchpassword
Mount Point: /CNPortletapp/rest/auth/matchpassword
POST
Checks if the given password matches the given hash As this method is possibly expensive (depends on the implemented hash algorithm), we don't allow anonymous access to it.
Parameters
name | description | type | default |
---|---|---|---|
sid | (no documentation provided) | query | 0 |
Request Body
element: | matchPasswordRequest |
media types: | */* application/xml application/json |
Password match request object
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
GenericResponse
/auth/ssologin
Mount Point: /CNPortletapp/rest/auth/ssologin
GET
Perform a login to the system with SSO systems
Response Body
element: | (custom) |
media types: | text/plain |
SID or "NOTFOUND" or "FAILURE"
/auth/logout/{sid}
Mount Point: /CNPortletapp/rest/auth/logout/{sid}
POST
Do a logout for the current session
Parameters
name | description | type | default |
---|---|---|---|
sid | (no documentation provided) | path | |
allSessions | (no documentation provided) | query | 0 |
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
generic response
/auth/validate/{sid}
Mount Point: /CNPortletapp/rest/auth/validate/{sid}
GET
Validate the given SID
Parameters
name | description | type | default |
---|---|---|---|
sid | sid to validate | path |
Response Body
element: | authenticationResponse |
media types: | */* application/xml application/json |
response containing validation result and (possibly) a user