Identities
Identities Resource of the University API
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /byuapi/identities
Version: v2
Default request content-types: application/json
Default response content-types: application/json
Schemes: https
Summary
Paths
Returns a collection of Identities
| byu_id | The identity's BYU ID | query | string[] | |
| person_id | The identity's identity ID | query | string[] | |
| net_id | The identity's Net ID | query | string[] | |
| credentials.credential_type | The type of credential being looked up | query | string , x ∈ { BYU_HAWAII_ID , BYU_IDAHO_ID , FACEBOOK_ID , GOOGLE_ID , ID_CARD , LDS_ACCOUNT_ID , LDS_CMIS_ID , NET_ID , PROX_CARD , SEMINARY_STUDENT_ID , SEOS_CARD , WSO2_CLIENT_ID } | |
| credentials.credential_id | The credential id | query | string (1 to 100 chars) | |
| credentials.user_name | The user name belonging to the credential type | query | string[] | |
| identity_name | The identity's name. A case-insensitive search is performed. You may insert '*' wildcards anywhere in the string, and a wildcard character is automatically appended. | query | string (up to 100 chars) , must match ^([A-Za-z-x27;*]+ )*?[A-Za-z-x27;*]+$ | |
| identity_type | The identity's type. A case-insensitive search is performed. You may insert '*' wildcards anywhere in the string, and a wildcard character is automatically appended. | query | string (up to 30 chars) , must match ^[0-9a-zA-Z]+$ | |
| test_record_responsible_byu_id | The identity's test_record_responsible_byu_id | query | string[] | |
| email_addresses.email_address | The identity's PERSONAL email address. A case-insensitive search is performed. A wildcard character is automatically appended. | query | string (email) | |
| email_aliases.email_alias | The identity's email alias. A case-insensitive search is performed. A wildcard character is automatically appended. | query | string (email) | |
| email_alias_logs.email_alias | The identity's email alias. A case-insensitive search is performed. A wildcard character is automatically appended. | query | string (email) | |
| phones.phone_number | The identity's phone number. A numerics-only search is performed. | query | string[] | |
| restricted | The FERPA restricted status | query | boolean | |
| field_sets | indicates which field sets are to be returned | query | string[] basic | |
| contexts | indicates which contexts are to be returned | query | string[] | |
| page_start | Which page to start on, Must be greater than 0 | query | integer (int32) 1 | |
| page_size | Size of the collection returned, Must be greater than 0 | query | integer (int32) 100 |
Uses default content-types: application/json
- 200 OK
-
A collection of Identities successfully returned
Example for application/json{
"links": {
"identities__create": {
"href": "https://api.byu.edu/byuapi/identities/v2/",
"method": "POST",
"rel": "identities__create"
},
"identities__current": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=1,page_size=50",
"method": "GET",
"rel": "identities__current"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/",
"method": "GET",
"rel": "self"
},
"identities__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=101,page_size=50",
"method": "GET",
"rel": "identities__next"
},
"identities__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=1,page_size=50",
"method": "GET",
"rel": "identities__prev"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"default_page_size": 50,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"max_page_size": 200,
"page_end": 1,
"page_size": 50,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
},
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
},
"address_line_3": {
"api_type": "modifiable",
"value": " "
},
"address_line_4": {
"api_type": "modifiable",
"value": " "
},
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
],
"key": true,
"value": "MAL"
},
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings",
"long_description": "",
"value": " "
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"city": {
"api_type": "modifiable",
"value": "Orem"
},
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": "USA"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
},
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
},
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"postal_code": {
"api_type": "modifiable",
"value": "84062"
},
"room": {
"api_type": "modifiable",
"value": " "
},
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states",
"value": "UT"
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"alias_domain": {
"api_type": "read-only",
"key": true,
"value": "@byu.edu"
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"limit": {
"api_type": "read-only",
"value": 25
},
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
},
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"quantity": {
"api_type": "derived",
"value": 4
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
},
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types",
"key": true,
"value": "NET_ID"
},
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
},
"issuing_location": {
"api_type": "system",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations",
"value": "133"
},
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
},
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
},
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"physical_form": {
"api_type": "modifiable",
"value": ""
},
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
},
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
},
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
},
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
],
"key": true,
"value": "PERSONAL"
},
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
},
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
},
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
},
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
},
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
},
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"group_membership_events": {
"links": {
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events",
"method": "GET",
"rel": "self"
},
"group_membership_events__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_membership_events__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"date_granted": {
"api_type": "system",
"value": ""
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"event_id": {
"api_type": "system",
"key": true,
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"granted_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_membership_events__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "GET",
"rel": "self"
},
"group_membership_events__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships",
"method": "GET",
"rel": "self"
},
"group_memberships__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_memberships__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_memberships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
},
"group_memberships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered",
"method": "GET",
"rel": "self"
},
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
},
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "inactivated_by_name_lnf",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
},
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
},
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"links": {
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789?field_sets=basic,addresse,salias_domains,credentials,email_addresses,email_aliases,group_membership_events,group_memberships,groups_administered,phones,relationships,validation_phrase",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"cell_flag": {
"api_type": "modifiable",
"value": ""
},
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
},
"country_number": {
"api_type": "derived",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
},
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
},
"phones__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
},
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": ""
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phone_number": {
"api_type": "modifiable",
"value": ""
},
"primary_flag": {
"api_type": "modifiable",
"value": ""
},
"texts_okay": {
"api_type": "modifiable",
"value": ""
},
"time_code": {
"api_type": "",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
},
"tty": {
"api_type": "modifiable",
"value": ""
},
"unlisted": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"work_flag": {
"api_type": "modifiable",
"value": ""
}
}
]
},
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
},
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
},
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"related_byu_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_identity_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_person_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"relationship_type": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"verified_datetime": {
"api_type": "system",
"value": ""
}
}
]
},
"validation_phrase": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"links": {
"validation_phrase__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "DELETE",
"rel": "self"
},
"validation_phrase__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "GET",
"rel": "self"
},
"validation_phrase__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"validation_phrase": {
"api_type": "modifiable",
"value": "This is a phrase to verify access for a phone caller"
}
}
}
]
} - 203 Non-Authoritative Information
-
A collection of Identities successfully returned
Example for application/json{
"links": {
"identities__create": {
"href": "https://api.byu.edu/byuapi/identities/v2/",
"method": "POST",
"rel": "identities__create"
},
"identities__current": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=1,page_size=50",
"method": "GET",
"rel": "identities__current"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/",
"method": "GET",
"rel": "self"
},
"identities__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=101,page_size=50",
"method": "GET",
"rel": "identities__next"
},
"identities__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=1,page_size=50",
"method": "GET",
"rel": "identities__prev"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"default_page_size": 50,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"max_page_size": 200,
"page_end": 1,
"page_size": 50,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
},
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
},
"address_line_3": {
"api_type": "modifiable",
"value": " "
},
"address_line_4": {
"api_type": "modifiable",
"value": " "
},
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
],
"key": true,
"value": "MAL"
},
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings",
"long_description": "",
"value": " "
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"city": {
"api_type": "modifiable",
"value": "Orem"
},
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": "USA"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
},
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
},
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"postal_code": {
"api_type": "modifiable",
"value": "84062"
},
"room": {
"api_type": "modifiable",
"value": " "
},
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states",
"value": "UT"
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"alias_domain": {
"api_type": "read-only",
"key": true,
"value": "@byu.edu"
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"limit": {
"api_type": "read-only",
"value": 25
},
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
},
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"quantity": {
"api_type": "derived",
"value": 4
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
},
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types",
"key": true,
"value": "NET_ID"
},
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
},
"issuing_location": {
"api_type": "system",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations",
"value": "133"
},
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
},
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
},
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"physical_form": {
"api_type": "modifiable",
"value": ""
},
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
},
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
},
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
},
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
],
"key": true,
"value": "PERSONAL"
},
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
},
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
},
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
},
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
},
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
},
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"group_membership_events": {
"links": {
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events",
"method": "GET",
"rel": "self"
},
"group_membership_events__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_membership_events__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"date_granted": {
"api_type": "system",
"value": ""
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"event_id": {
"api_type": "system",
"key": true,
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"granted_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_membership_events__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "GET",
"rel": "self"
},
"group_membership_events__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships",
"method": "GET",
"rel": "self"
},
"group_memberships__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_memberships__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_memberships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
},
"group_memberships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered",
"method": "GET",
"rel": "self"
},
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
},
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "inactivated_by_name_lnf",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
},
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
},
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"links": {
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789?field_sets=basic,addresse,salias_domains,credentials,email_addresses,email_aliases,group_membership_events,group_memberships,groups_administered,phones,relationships,validation_phrase",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"cell_flag": {
"api_type": "modifiable",
"value": ""
},
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
},
"country_number": {
"api_type": "derived",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
},
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
},
"phones__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
},
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": ""
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phone_number": {
"api_type": "modifiable",
"value": ""
},
"primary_flag": {
"api_type": "modifiable",
"value": ""
},
"texts_okay": {
"api_type": "modifiable",
"value": ""
},
"time_code": {
"api_type": "",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
},
"tty": {
"api_type": "modifiable",
"value": ""
},
"unlisted": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"work_flag": {
"api_type": "modifiable",
"value": ""
}
}
]
},
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
},
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
},
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"related_byu_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_identity_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_person_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"relationship_type": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"verified_datetime": {
"api_type": "system",
"value": ""
}
}
]
},
"validation_phrase": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"links": {
"validation_phrase__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "DELETE",
"rel": "self"
},
"validation_phrase__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "GET",
"rel": "self"
},
"validation_phrase__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"validation_phrase": {
"api_type": "modifiable",
"value": "This is a phrase to verify access for a phone caller"
}
}
}
]
} - 207 Multi-status
-
A collection of Identities successfully returned
Example for application/json{
"links": {
"identities__create": {
"href": "https://api.byu.edu/byuapi/identities/v2/",
"method": "POST",
"rel": "identities__create"
},
"identities__current": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=1,page_size=50",
"method": "GET",
"rel": "identities__current"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/",
"method": "GET",
"rel": "self"
},
"identities__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=101,page_size=50",
"method": "GET",
"rel": "identities__next"
},
"identities__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/?page_start=1,page_size=50",
"method": "GET",
"rel": "identities__prev"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"default_page_size": 50,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"max_page_size": 200,
"page_end": 1,
"page_size": 50,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
},
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
},
"address_line_3": {
"api_type": "modifiable",
"value": " "
},
"address_line_4": {
"api_type": "modifiable",
"value": " "
},
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
],
"key": true,
"value": "MAL"
},
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings",
"long_description": "",
"value": " "
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"city": {
"api_type": "modifiable",
"value": "Orem"
},
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": "USA"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
},
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
},
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"postal_code": {
"api_type": "modifiable",
"value": "84062"
},
"room": {
"api_type": "modifiable",
"value": " "
},
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states",
"value": "UT"
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"alias_domain": {
"api_type": "read-only",
"key": true,
"value": "@byu.edu"
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"limit": {
"api_type": "read-only",
"value": 25
},
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
},
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"quantity": {
"api_type": "derived",
"value": 4
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
},
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types",
"key": true,
"value": "NET_ID"
},
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
},
"issuing_location": {
"api_type": "system",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations",
"value": "133"
},
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
},
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
},
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"physical_form": {
"api_type": "modifiable",
"value": ""
},
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
},
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
},
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
},
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
],
"key": true,
"value": "PERSONAL"
},
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
},
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
},
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
},
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
},
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
},
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"group_membership_events": {
"links": {
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events",
"method": "GET",
"rel": "self"
},
"group_membership_events__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_membership_events__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"date_granted": {
"api_type": "system",
"value": ""
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"event_id": {
"api_type": "system",
"key": true,
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"granted_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_membership_events__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "GET",
"rel": "self"
},
"group_membership_events__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships",
"method": "GET",
"rel": "self"
},
"group_memberships__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_memberships__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_memberships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
},
"group_memberships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered",
"method": "GET",
"rel": "self"
},
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
},
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "inactivated_by_name_lnf",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
},
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
},
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"links": {
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789?field_sets=basic,addresse,salias_domains,credentials,email_addresses,email_aliases,group_membership_events,group_memberships,groups_administered,phones,relationships,validation_phrase",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"cell_flag": {
"api_type": "modifiable",
"value": ""
},
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
},
"country_number": {
"api_type": "derived",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
},
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
},
"phones__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
},
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": ""
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phone_number": {
"api_type": "modifiable",
"value": ""
},
"primary_flag": {
"api_type": "modifiable",
"value": ""
},
"texts_okay": {
"api_type": "modifiable",
"value": ""
},
"time_code": {
"api_type": "",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
},
"tty": {
"api_type": "modifiable",
"value": ""
},
"unlisted": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"work_flag": {
"api_type": "modifiable",
"value": ""
}
}
]
},
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
},
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
},
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"related_byu_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_identity_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_person_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"relationship_type": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"verified_datetime": {
"api_type": "system",
"value": ""
}
}
]
},
"validation_phrase": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"links": {
"validation_phrase__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "DELETE",
"rel": "self"
},
"validation_phrase__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "GET",
"rel": "self"
},
"validation_phrase__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"validation_phrase": {
"api_type": "modifiable",
"value": "This is a phrase to verify access for a phone caller"
}
}
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
The resource does not exist
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- 500 Internal Server Error #/responses/500
-
Internal Server Error - Error occurred that wasn't the user's fault
- 503 Service Unavailable #/responses/503
-
Service Unavailable - Under construction
- 504 Gateway Timeout #/responses/504
-
Gateway Timeout
- default #/responses/default
-
Unexpected error
Creates an Identity
Uses default content-types: application/json
Uses default content-types: application/json
- 201 Created
-
Identity successfully created
Example for application/json{
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
} - 207 Multi-status #/responses/207
-
Partial Success - unable to raise event
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
The resource does not exist
- 405 Method Not Allowed #/responses/405
-
Method Not Allowed
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- 500 Internal Server Error #/responses/500
-
Internal Server Error - Error occurred that wasn't the user's fault
- 503 Service Unavailable #/responses/503
-
Service Unavailable - Under construction
- 504 Gateway Timeout #/responses/504
-
Gateway Timeout
- default #/responses/default
-
Unexpected error
Deletes the identity with the specified BYU ID
| byu_id | The identity's BYU ID | path | string , must match ^[0-9]{9}$ |
Uses default content-types: application/json
- 204 No Content
-
Identity successfully deleted
- 207 Multi-status #/responses/207
-
Partial Success - unable to raise event
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
The resource does not exist
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- 500 Internal Server Error #/responses/500
-
Internal Server Error - Error occurred that wasn't the user's fault
- 503 Service Unavailable #/responses/503
-
Service Unavailable - Under construction
- 504 Gateway Timeout #/responses/504
-
Gateway Timeout
- default #/responses/default
-
Unexpected error
Returns the identity with the specified BYU ID
| byu_id | The identity's BYU ID | path | string , must match ^[0-9]{9}$ | |
| field_sets | indicates which field sets are to be returned | query | string[] basic | |
| contexts | indicates which contexts are to be returned | query | string[] |
Uses default content-types: application/json
- 200 OK
-
Identity successfully returned
Example for application/json{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
},
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
},
"address_line_3": {
"api_type": "modifiable",
"value": " "
},
"address_line_4": {
"api_type": "modifiable",
"value": " "
},
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
],
"key": true,
"value": "MAL"
},
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings",
"long_description": "",
"value": " "
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"city": {
"api_type": "modifiable",
"value": "Orem"
},
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": "USA"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
},
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
},
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"postal_code": {
"api_type": "modifiable",
"value": "84062"
},
"room": {
"api_type": "modifiable",
"value": " "
},
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states",
"value": "UT"
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"alias_domain": {
"api_type": "read-only",
"key": true,
"value": "@byu.edu"
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"limit": {
"api_type": "read-only",
"value": 25
},
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
},
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"quantity": {
"api_type": "derived",
"value": 4
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
},
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types",
"key": true,
"value": "NET_ID"
},
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
},
"issuing_location": {
"api_type": "system",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations",
"value": "133"
},
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
},
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
},
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"physical_form": {
"api_type": "modifiable",
"value": ""
},
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
},
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
},
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
},
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
],
"key": true,
"value": "PERSONAL"
},
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
},
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
},
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
},
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
},
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
},
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"group_membership_events": {
"links": {
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events",
"method": "GET",
"rel": "self"
},
"group_membership_events__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_membership_events__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"date_granted": {
"api_type": "system",
"value": ""
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"event_id": {
"api_type": "system",
"key": true,
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"granted_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_membership_events__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "GET",
"rel": "self"
},
"group_membership_events__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships",
"method": "GET",
"rel": "self"
},
"group_memberships__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_memberships__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_memberships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
},
"group_memberships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered",
"method": "GET",
"rel": "self"
},
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
},
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "inactivated_by_name_lnf",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
},
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
},
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"links": {
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789?field_sets=basic,addresse,salias_domains,credentials,email_addresses,email_aliases,group_membership_events,group_memberships,groups_administered,phones,relationships,validation_phrase",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"cell_flag": {
"api_type": "modifiable",
"value": ""
},
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
},
"country_number": {
"api_type": "derived",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
},
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
},
"phones__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
},
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": ""
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phone_number": {
"api_type": "modifiable",
"value": ""
},
"primary_flag": {
"api_type": "modifiable",
"value": ""
},
"texts_okay": {
"api_type": "modifiable",
"value": ""
},
"time_code": {
"api_type": "",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
},
"tty": {
"api_type": "modifiable",
"value": ""
},
"unlisted": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"work_flag": {
"api_type": "modifiable",
"value": ""
}
}
]
},
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
},
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
},
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"related_byu_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_identity_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_person_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"relationship_type": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"verified_datetime": {
"api_type": "system",
"value": ""
}
}
]
},
"validation_phrase": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"links": {
"validation_phrase__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "DELETE",
"rel": "self"
},
"validation_phrase__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "GET",
"rel": "self"
},
"validation_phrase__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"validation_phrase": {
"api_type": "modifiable",
"value": "This is a phrase to verify access for a phone caller"
}
}
} - 203 Non-Authoritative Information
-
Public Identity successfully returned
Example for application/json{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
},
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
},
"address_line_3": {
"api_type": "modifiable",
"value": " "
},
"address_line_4": {
"api_type": "modifiable",
"value": " "
},
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
],
"key": true,
"value": "MAL"
},
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings",
"long_description": "",
"value": " "
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"city": {
"api_type": "modifiable",
"value": "Orem"
},
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": "USA"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
},
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
},
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"postal_code": {
"api_type": "modifiable",
"value": "84062"
},
"room": {
"api_type": "modifiable",
"value": " "
},
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states",
"value": "UT"
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"alias_domain": {
"api_type": "read-only",
"key": true,
"value": "@byu.edu"
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"limit": {
"api_type": "read-only",
"value": 25
},
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
},
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"quantity": {
"api_type": "derived",
"value": 4
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
},
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types",
"key": true,
"value": "NET_ID"
},
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
},
"issuing_location": {
"api_type": "system",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations",
"value": "133"
},
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
},
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
},
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"physical_form": {
"api_type": "modifiable",
"value": ""
},
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
},
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
},
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
},
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
],
"key": true,
"value": "PERSONAL"
},
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
},
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
},
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
},
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
},
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
},
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"group_membership_events": {
"links": {
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events",
"method": "GET",
"rel": "self"
},
"group_membership_events__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_membership_events__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"date_granted": {
"api_type": "system",
"value": ""
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"event_id": {
"api_type": "system",
"key": true,
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"granted_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_membership_events__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "GET",
"rel": "self"
},
"group_membership_events__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships",
"method": "GET",
"rel": "self"
},
"group_memberships__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_memberships__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_memberships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
},
"group_memberships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered",
"method": "GET",
"rel": "self"
},
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
},
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "inactivated_by_name_lnf",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
},
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
},
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"links": {
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789?field_sets=basic,addresse,salias_domains,credentials,email_addresses,email_aliases,group_membership_events,group_memberships,groups_administered,phones,relationships,validation_phrase",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships"
],
"contact": [
"basic",
"addresses",
"email_addresses",
"phones"
]
},
"default_field_sets": [
"basic"
],
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"group_membership_events",
"group_memberships",
"groups_administered",
"page_counts",
"phones",
"relationships",
"validation_phrase"
],
"field_sets_returned": [
"basic",
"addresses",
"alias_domains",
"credentials",
"email_addresses",
"email_aliases",
"group_membership_events",
"group_memberships",
"groups_administered",
"phones",
"relationships",
"validation_phrase"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"cell_flag": {
"api_type": "modifiable",
"value": ""
},
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
},
"country_number": {
"api_type": "derived",
"value": ""
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
},
"phones__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
},
"phones__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
},
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": ""
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"phone_number": {
"api_type": "modifiable",
"value": ""
},
"primary_flag": {
"api_type": "modifiable",
"value": ""
},
"texts_okay": {
"api_type": "modifiable",
"value": ""
},
"time_code": {
"api_type": "",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
},
"tty": {
"api_type": "modifiable",
"value": ""
},
"unlisted": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"work_flag": {
"api_type": "modifiable",
"value": ""
}
}
]
},
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
},
"relationships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
},
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"related_byu_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_identity_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"related_person_id": {
"api_type": "related",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/identities/v2/:related_byu_id",
"value": ""
},
"relationship_type": {
"api_type": "modifiable",
"value": ""
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"verified_datetime": {
"api_type": "system",
"value": ""
}
}
]
},
"validation_phrase": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"links": {
"validation_phrase__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "DELETE",
"rel": "self"
},
"validation_phrase__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "GET",
"rel": "self"
},
"validation_phrase__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/validation_phrase",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"validation_phrase": {
"api_type": "modifiable",
"value": "This is a phrase to verify access for a phone caller"
}
}
} - 207 Multi-status
-
Multi Status
Example for application/json{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
},
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
},
"address_line_3": {
"api_type": "modifiable",
"value": " "
},
"address_line_4": {
"api_type": "modifiable",
"value": " "
},
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
],
"key": true,
"value": "MAL"
},
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings",
"long_description": "",
"value": " "
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"city": {
"api_type": "modifiable",
"value": "Orem"
},
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": "USA"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
},
"addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
},
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"postal_code": {
"api_type": "modifiable",
"value": "84062"
},
"room": {
"api_type": "modifiable",
"value": " "
},
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states",
"value": "UT"
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"alias_domain": {
"api_type": "read-only",
"key": true,
"value": "@byu.edu"
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"limit": {
"api_type": "read-only",
"value": 25
},
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
},
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"quantity": {
"api_type": "derived",
"value": 4
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"datetime_ferpa_last_displayed": {
"api_type": "read-only",
"value": "2017-09-09T19:15:22.123Z"
},
"identity_name": {
"api_type": "modifiable",
"value": "Abernathy Rodriguez"
},
"identity_type": {
"api_type": "modifiable",
"value": "Person"
},
"links": {
"identities__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "DELETE",
"rel": "self"
},
"identities__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "GET",
"rel": "self"
},
"identities__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789",
"method": "PUT",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
},
"person_id": {
"api_type": "system",
"value": "987654321"
},
"test_record_responsible_byu_id": {
"api_type": "modifiable",
"description": "Cosmo Cougar",
"value": "123456789"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
},
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
},
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types",
"key": true,
"value": "NET_ID"
},
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
},
"issuing_location": {
"api_type": "system",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations",
"value": "133"
},
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
},
"credentials__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
},
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"physical_form": {
"api_type": "modifiable",
"value": ""
},
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
},
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
},
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
},
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
],
"key": true,
"value": "PERSONAL"
},
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
},
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
},
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"unlisted": {
"api_type": "modifiable",
"value": false
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
},
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
},
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
},
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
},
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
},
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
},
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
},
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
},
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
},
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
},
"group_membership_events": {
"links": {
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events",
"method": "GET",
"rel": "self"
},
"group_membership_events__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_membership_events__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"date_granted": {
"api_type": "system",
"value": ""
},
"date_inactivated": {
"api_type": "system",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"effective_date": {
"api_type": "system",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"event_id": {
"api_type": "system",
"key": true,
"value": ""
},
"expiration_date": {
"api_type": "system",
"value": ""
},
"granted_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"group_description": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"inactivated_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_membership_events__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_membership_events__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "GET",
"rel": "self"
},
"group_membership_events__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_membership_events/:event_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships",
"method": "GET",
"rel": "self"
},
"group_memberships__next": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__next"
},
"group_memberships__prev": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "group_membership_events__prev"
}
},
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
},
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
],
"validation_response": {
"response": "Success",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"department": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"employee_type": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"group_id": {
"api_type": "related",
"description": "",
"key": true,
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"group_type": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/groups",
"value": ""
},
"job_title": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
},
"links": {
"group_memberships__delete": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "DELETE",
"rel": "group_membership_events__delete"
},
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
},
"group_memberships__modify": {
"href": "https://api.byu.edu/byuapi/identities/v2/123456789/group_memberships/:group_id",
"method": "PUT",
"rel": "group_membership_events__modify"
}
},
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
],
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"response": "Success",
"return_code": 200
}
}
}
]
},
"groups_administered": {
"links": {
"groups_administered__