IdentityAccessGrantAuthorization

This service will return a list of information areas that can be granted to a user 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/grantauthorization

Version: v1

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

Summary

Path Operation Description
/ GET

Returns list of current users grantable information areas.

/documentation GET

service definition

/{personId_netId}/{creditInst}/{infoArea}/{filter} GET

Returns all (A), active (C), or expired (E) limitations based on the filter, selected information area and credit institution for the selected person ID or net ID

Paths

Returns list of current users grantable information areas.

GET /

Tags: GrantAuthorizationService

Returns list of current users grantable information areas.

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.

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

Returns all (A), active (C), or expired (E) limitations based on the filter, selected information area and credit institution for the selected person ID or net ID

GET /{personId_netId}/{creditInst}/{infoArea}/{filter}

Tags: GrantAuthorizationService

Returns all (A), active (C), or expired (E) limitations based on the filter, selected information area and credit institution for the selected person ID or net ID

personId_netId

string -> [0-9]{9} 9 digit number or identifier.

path string
creditInst

string -> Enumerated in the getInfoAreas method with no parameters. Case sensitive.

path string
infoArea

string -> Enumerated in the getInfoAreas method with no parameters. Case sensitive.

path string
filter

string -> [A|C|E] for all, active, or expired, respectively.

path string

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.

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

GrantAuthService: object

request: object
method: string
resource: string
attributes: string
status: number
statusMessage: string
errors: object[]
object
code: number
name: string
message: string
httpStatusCode: number
response: object
Service Path: 
/domains/legacy/identity/access/grantauthorization
Domain or University API: 
/domains/D/identity/access/grantauthorization

Community

 

Don't see your question listed here? Ask!