IdentityPersonResolveIdentity

ResolveIdentityService

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

Base URL: /domains/legacy/identity/person/resolveidentity

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/ids* GET

The user supplies either person_id, byu_id, net_id and all three IDs are returned

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

The user supplies either person_id, byu_id, net_id and all three IDs are returned

GET /ids*

Tags: ResolveIdentityService

The user supplies either person_id, byu_id, net_id and all three IDs are returned

person_id

string ->

query string
byu_id

string ->

query string
net_id

string ->

query string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"ResolveIdentityService": {
"request": {
"attributes": "net_id=johnd",
"method": "GET",
"resource": "/json",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"authorized": "Y",
"byu_id": "987654321",
"net_id": "johnd",
"person_id": "123456789",
"sort_name": "Doe, John A"
}
}
}
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.

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

documentation: object

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

errors: object[]

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

errors2: object[]

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

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

ResolveIDService: object

ResolveIdentityService: object
request: request
errors: errors2
response: response

response: object

person_id: string
byu_id: string
net_id: string
sort_name: string
authorized: string
Service Path: 
/domains/legacy/identity/person/resolveidentity
Domain or University API: 
/domains/D/identity/person/resolveidentity

Community

 

Don't see your question listed here? Ask!