IdentityAccessUserAuthorizations

This service will return a list 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/userauthorizations

Version: v1

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

Summary

Path Operation Description
/ GET

This returns the set of info areas that the authenticated user is allowed to grant.

/documentation GET

service definition

/{person_id}/{info_area} GET

Gets current status of authorization for the given person identified by person id.

Paths

This returns the set of info areas that the authenticated user is allowed to grant.

GET /

Tags: UserAuthorizationsService

This returns the set of info areas that the authenticated user is allowed to grant.

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

200 OK

Service request is OK and a response has been generated.

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.

service definition

GET /documentation

service definition

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

200 OK

Success

Gets current status of authorization for the given person identified by person id.

GET /{person_id}/{info_area}

Tags: UserAuthorizationsService

Gets current status of authorization for the given person identified by person id.

person_id

string -> nine digit number

path string
info_area

string -> an informational area of access

path 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
{
"UserAuthService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789/INFOAREA",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"informational_area_summary": {
"clockEndHour": "00",
"clockEndMin": "00",
"clockStartHour": "00",
"clockStartMin": "00",
"dateTimeGranted": "1 Jan 2017",
"dateTimeRevoked": "31 Dec 2017",
"domainIp1": "*",
"domainIp2": "*",
"domainIp3": "*",
"domainIp4": "*",
"effectiveDate": "1 Jan 2017",
"expiredDate": "31 Dec 2017",
"grantedBy": "Doe, Jane Marie",
"informationalArea": "INFOAREA",
"limitationType": "CMP",
"limitationValue": "X",
"personId": "123456789",
"personName": "Doe, John Albert",
"revokedBy": "Smith, Fred David"
}
}
}
}
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

AuthService: object

UserAuthService: object
request: request
response: response

AuthService2: object

UserAuthService: object
request: request
response: response2

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

list: object[]

object
name: 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

infoAreaList: list
institutionList: list

response2: object

informational_area_summary: object
personName: string

lastName, firstName, middleName

personId: string
informationalArea: string
effectiveDate: string
expiredDate: string
dateTimeGranted: string
grantedBy: string
dateTimeRevoked: string
revokedBy: string
limitationType: string
limitationValue: string
clockStartHour: string
clockStartMin: string
clockEndHour: string
clockEndMin: string
domainIp1: string
domainIp2: string
domainIp3: string
domainIp4: string
Service Path: 
/domains/legacy/identity/access/userauthorizations
Domain or University API: 
/domains/D/identity/access/userauthorizations

Community

 

Don't see your question listed here? Ask!