IdentityAccessUserAuthorizationSummary

This service will return a summary of authorizations a user has in the C-Framework (AIM or Person systems).

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/identity/access/userauthorizationsummary

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/documentation GET

service definition

/{personId}/{listView}/{listFilter} GET

Shows page according to specified person Id

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Shows page according to specified person Id

GET /{personId}/{listView}/{listFilter}

Tags: UserAuthorizationSummaryService

Shows page according to specified person Id

personId

string -> 9 digit number; [0-9]{9}

path string
listView

string -> accessRights, roleTypes, or grantRights. Case sensitive.

path string
listFilter

string -> All, Active, or Expired. Case sensitive.

path string
page

string -> The page of returned rows that you would like to display

query string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"UserAuthSummaryService": {
"request": {
"attributes": "page=1",
"method": "GET",
"resource": "/838206532/accessRights/Active",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"accessRightsList": [
{
"allowableDomain": "*.*.*.*",
"clockEndTime": ":00",
"clockStartTime": ":00",
"dateTimeGranted": "10 Aug 2010",
"dateTimeRevoked": "25 Nov 2015",
"effectiveDate": "10 Aug 2010",
"expectedDate": "20 Jun 2010",
"expiredDate": "25 Nov 2015",
"grantedById": "johnd",
"infoArea": "PERSON",
"limitationType": "Office",
"limitationValue": "Other",
"revokedById": "janed",
"updateType": "D"
}
]
,
"totalPages": 1
}
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

AuthSummary: object

UserAuthSummaryService: object
request: request
response: response

docErrors: object[]

object
code: integer
name: string
message: string
httpStatusCode: integer

documentation: object

WebService: object
name: string
operations: operations
errors: docErrors
httpStatusCodes: httpStatusCodes

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

httpStatusCodes: object[]

object
code: integer
message: string

operations: object[]

object
name: string
description: string
method: string
path: string
path_identifiers: object[]
object
name: string
type: string
format: string
query_attributes: object[]
object
name: string
type: string
format: string
required: string

request: object

method: string
resource: string
attributes: string
status: integer
statusMessage: string

response: object

totalPages: integer
accessRightsList: object[]
object
infoArea: string
expectedDate: string
effectiveDate: string
expiredDate: string
dateTimeGranted: string
grantedById: string
dateTimeRevoked: string
revokedById: string
updateType: string
limitationType: string
limitationValue: string
clockStartTime: string
clockEndTime: string
allowableDomain: string
Service Path: 
/domains/legacy/identity/access/userauthorizationsummary
Domain or University API: 
/domains/D/identity/access/userauthorizationsummary

Community

 

Don't see your question listed here? Ask!