IdentitiesLite
Demo Identities Resource API for CES Institutions
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /cesapi/identitieslite
Version: v1
Default response content-types: application/json
Schemes: https
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | Identities |
| POST | Identities | |
| /{byu_id} | DELETE | Identities |
| GET | Identities | |
| PUT | Identities | |
| /{byu_id}/credentials | GET | Credentials |
| /{byu_id}/credentials/{credential_type},{credential_id} | DELETE | Credentials |
| GET | Credentials | |
| PUT | Credentials |
Paths
Returns a collection of Identities
| net_id | The person's Net ID | query | string , must match ^[a-z][a-z0-9]{0,8}$ | |
| credential_type | The type of credential being looked up | query | string , x ∈ { GOOGLE_ID , FACEBOOK_ID , LDS_ACCOUNT_ID , LDS_CMIS_ID , BYU_IDAHO_ID , BYU_HAWAII_ID , PROX_CARD , ID_CARD , WSO2_CLIENT_ID } | |
| credential_id | The credential id | query | string (1 to 100 chars) | |
| user_name | The user name belonging to the credential type | query | string | |
| email_address | The person's PERSONAL email address. A case-insensitive search is performed. A wildcard character is automatically appended. | query | string (email) | |
| phone_number | The person's phone number. A numerics-only search is performed. | query | string (5 to 30 chars) , must match ^[0-9]{5,30}$ | |
| surname | The person's surname. 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 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$ | |
| rest_of_name | The person's given names. A case-insensitive search is performed. | query | string (up to 80 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$ | |
| preferred_surname | The person's preferred surname. A case-insensitive search is performed. | query | string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$ | |
| preferred_first_name | The person's preferred first name. A case-insensitive search is performed. | query | string (up to 25 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$ | |
| field_sets | List which sub resources are to be returned | query | string , x ∈ { basic , credentials , email_addresses } | #/parameters/field_sets |
| context | Indicates a set of sub resources | query | string , x ∈ { all } | #/parameters/context |
| page_start | Skip into a large collection to this item | query | string | #/parameters/page_start |
| page_size | Return this many items of a large collection | query | string | #/parameters/page_size |
Uses default content-types: application/json
- 200 OK
-
A collection of Identities successfully returned
Example for application/json{
"links": {
"identitieslite__create": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1",
"method": "POST",
"rel": "identitieslite__create"
},
"identitieslite__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"identitieslite__next": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "identitieslite__next"
},
"identitieslite__prev": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "identitieslite__prev"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"credentials"
]
},
"default_page_size": 50,
"field_sets_available": [
"basic",
"credentials"
],
"field_sets_returned": [
"basic",
"credentials"
],
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
},
"values": [
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
}
}
]
} - 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
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Creates an Identity
The identity values to be set
Uses default content-types: application/json
- 201 Created
-
Identity successfully created
Example for application/json{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
}
} - 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
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Deletes the identity with the specified BYU ID
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
Uses default content-types: application/json
- 204 No Content
-
Person successfully deleted
- 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
- default #/responses/default
-
Unexpected error
Returns the identity for the specified BYU ID
| field_sets | List which sub resources are to be returned | query | string , x ∈ { basic , credentials , email_addresses } | #/parameters/field_sets |
| context | Indicates a set of sub resources | query | string , x ∈ { all } | #/parameters/context |
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
Uses default content-types: application/json
- 200 OK
-
Identity successfully returned
Example for application/json{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
}
} - 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
-
Identity not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modifies the Identities with specified BYU ID
The basic Identity data to be updated
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
Uses default content-types: application/json
- 200 OK
-
Identity successfully updated
Example for application/json{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
}
} - 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
-
Identity not Found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns all credentials for the BYU ID
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
Uses default content-types: application/json
- 200 OK
-
Credentials successfully returned
Example for application/json{
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
} - 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
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Deletes a credential
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
| credential_id | The unique account identifier provided by the ACP. | path | string | |
| credential_type | One of the credential types available through the meta/credential_type service. | path | string |
Uses default content-types: application/json
- 204 No Content
-
Credential successfully deleted
- 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
- default #/responses/default
-
Unexpected error
Returns the credential for the BYU ID/credential_type
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
| credential_id | The unique account identifier provided by the ACP. | path | string | |
| credential_type | One of the credential types available through the meta/credential_type service. | path | string |
Uses default content-types: application/json
- 200 OK
-
Credential successfully returned
Example for application/json{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
} - 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
-
Credential not Found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modifies or creates a credential
The attributes of the credential to be created or updated
| byu_id | The person's BYU ID | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
| credential_id | The unique account identifier provided by the ACP. | path | string | |
| credential_type | One of the credential types available through the meta/credential_type service. | path | string |
Uses default content-types: application/json
- 200 OK
-
Credential successfully updated/modified
Example for application/json{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
} - 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
-
Credential not Found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Parameter definitions
Response definitions
- 400
-
Invalid Request - unable to interpret request
- 401
-
Authentication required to access data
- 403
-
Access denied to protected data
- 409
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Schema definitions
Basic field_set for the Identity Lite API
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
} - links: object
-
Hypermedia Links that impact this Identity
- identitieslite__info: object
-
Hypermedia link to retrieve this Identity
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1/:byu_id
-
- method: string , x ∈ { GET (default) }
-
- identitieslite__modify: object
-
Hypermedia link to modify an Identity
- rel: string , x ∈ { identitieslite__modify (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1/764634873
-
- method: string , x ∈ { PUT (default) }
-
- identitieslite__remove: object
-
Hypermedia link to remove an Identity
- rel: string , x ∈ { identitieslite__remove (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1/764634873
-
- method: string , x ∈ { DELETE (default) }
-
- metadata: simple_metadata
-
- byu_id: byu_id
-
- person_id: person_id
-
- surname: surname
-
- first_name: first_name
-
- middle_name: middle_name
-
- rest_of_name: rest_of_name
-
- suffix: suffix
-
- preferred_surname: preferred_surname
-
- preferred_first_name: preferred_first_name
-
- preferred_name: preferred_name
-
- name_fnf: name_fnf
-
- name_lnf: name_lnf
-
- email_address: email_address
-
- phone_number: phone_number
-
- texts_okay: texts_okay
-
- created_by_id: created_by_id
-
- date_time_created: date_time_created
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
Information required to modify the basic portion of the Identity
{
"created_by_id": "764634873",
"date_time_created": "2014-05-11T13:45:53.20Z",
"date_time_updated": "2014-05-11T13:45:53.20Z",
"email_address": "bugsbunny22@gmail.com",
"first_name": "Bugs",
"middle_name": "Bunny",
"person_id": "585241162",
"phone_number": "8014222507",
"preferred_first_name": "Bugs",
"preferred_surname": "Ithaca",
"suffix": "Esq.",
"surname": "Ithaca",
"texts_okay": "N",
"updated_by_id": "764634873"
} - byu_id: string
-
- person_id: string
-
- surname: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- first_name: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- middle_name: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- suffix: string (1 to 10 chars) , must match ^( |Sr|SR|JR|Jr|M{0,4}(CM|CD|D?C{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3}))$
-
Generational suffix for name: Roman Numeral, JR, SR, Jr, or Sr
- preferred_surname: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- preferred_first_name: string (up to 25 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- email_address: string
-
- phone_number: string
-
- texts_okay: string
-
- created_by_id: string , must match ^([]{0}|[0-9]{9})$
-
- date_time_created: string (date-time)
-
- updated_by_id: string , must match ^([]{0}|[0-9]{9})$
-
- date_time_updated: string (date-time)
-
Unique BYU Identifier
{
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
} - value: string (up to 9 chars)
-
- api_type: string , x ∈ { system (default) }
-
- key: boolean
-
- display_label: string Applicant ID
-
Who created the Identity?
{
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
} - value: string
-
- api_type: string , x ∈ { system (default) }
-
- description: string
-
- display_label: string Application created by?
-
Credential for the Identity
- links: object
-
Hypermedia Links that impact a Credential for an applicant
- credentials__info: object
-
Hypermedia link to retrieve Credentials on the Undergraduate Application
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/undergraduate_applications/v1/:application_uuid/credentials/:credential_name,:credential_type
-
- method: string , x ∈ { GET (default) }
-
- identities__info: object
-
Hypermedia link to retrieve Credentials for an Identity
- rel: string , x ∈ { identities__info (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identities/v1/:applicant_id/credentials/:credential_name,:credential_type
-
- method: string , x ∈ { GET (default) }
-
- metadata: simple_metadata
-
- byu_id: byu_id
-
- credential_id: credential_id
-
- credential_type: credential_type
-
- user_name: user_name
-
- scoped_affiliation: scoped_affiliation
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
The internal identifier for a credential system, for example: byu_id at BYU or CMIS_ID for church
{
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
} - value: string
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- key: boolean
-
- display_label: string Credential ID
-
Information required to create/modify a Credential
{
"date_time_updated": "2014-05-11T13:45:53.20Z",
"scoped_affiliation": "student@byui.edu",
"updated_by_id": "764634873",
"user_name": "ib37"
} - user_name: string
-
- scoped_affiliation: string
-
- updated_by_id: string , must match ^([]{0}|[0-9]{9})$
-
- date_time_updated: string (date-time)
-
They credential type - google account, facebook account, byu net_id, or prox_id number
{
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
} - value: string
-
- description: string
-
- domain: string (uri) https://api.byu.edu/byuapi/meta/credential_types/v1
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- key: boolean
-
- display_label: string Credential Types
-
Collection of Credentials for the Identity
- links: object
-
Hypermedia Links that impact the collection of Credentials
- credentials__info: object
-
Hypermedia link to retrieve the Credentials for an Identity
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials
-
- method: string , x ∈ { GET (default) }
-
- credentials__associate: object
-
Hypermedia link to associate a new Credential to an Identity
- rel: string , x ∈ { credentials__associate (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id
-
- method: string , x ∈ { PUT (default) }
-
- metadata: sub_level_metadata
-
- values: object[]
When was the Identity created?
{
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
} - value: string (date-time)
-
- api_type: string , x ∈ { system (default) }
-
- display_label: string Application created when?
-
When was the Identity last updated?
{
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
} - value: string (date-time)
-
- api_type: string , x ∈ { system (default) }
-
- display_label: string Application last updated when?
-
Email Address
{
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) , read-only }
-
- display_label: string Email
-
Legal First Name
{
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
} - value: string (up to 40 chars)
-
- api_type: string , x ∈ { modifiable (default) , read-only }
-
- display_label: string First Name
-
A collection of Skeleton Identities
{
"links": {
"identitieslite__create": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1",
"method": "POST",
"rel": "identitieslite__create"
},
"identitieslite__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"identitieslite__next": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "identitieslite__next"
},
"identitieslite__prev": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "identitieslite__prev"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"credentials"
]
},
"default_page_size": 50,
"field_sets_available": [
"basic",
"credentials"
],
"field_sets_returned": [
"basic",
"credentials"
],
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
},
"values": [
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
}
}
]
} - links: object
-
Hypermedia Links that impact the Identities collection
- identitieslite__info: object
-
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1?page_start=51&page_size=50
-
- method: string , x ∈ { GET (default) }
-
- identitieslite__prev: object
-
- rel: string , x ∈ { identitieslite__prev (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- identitieslite__next: object
-
- rel: string , x ∈ { identitieslite__next (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- identitieslite__create: object
-
- rel: string , x ∈ { identitieslite__create (default) }
-
- href: string (uri) https://api.byu.edu/cesapi/identitieslite/v1
-
- method: string , x ∈ { POST (default) }
-
- metadata: top_level_metadata
-
- values: object[]
An Identity
{
"basic": {
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity created by?",
"value": "764634873"
},
"date_time_created": {
"api_type": "system",
"display_label": "Identity created when?",
"value": "2014-05-11T13:45:53.20Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Identity last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"email_address": {
"api_type": "modifiable",
"display_label": "Email",
"value": "bugsbunny22@gmail.com"
},
"first_name": {
"api_type": "modifiable",
"display_label": "First Names",
"value": "Bugs"
},
"links": {
"identitieslite__info": {
"href": "https://api.byu.edu/identitieslite/v1/764634873",
"method": "GET",
"rel": "self"
},
"identitieslite__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "PUT",
"rel": "identitieslite__modify"
},
"identitieslite__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873",
"method": "DELETE",
"rel": "identitieslite__remove"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"middle_name": {
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
},
"name_fnf": {
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
},
"name_lnf": {
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
},
"person_id": {
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
},
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
},
"preferred_first_name": {
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
},
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
},
"preferred_surname": {
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
},
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
},
"suffix": {
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
},
"surname": {
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
},
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
}
},
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"values": [
{
"byu_id": {
"api_type": "system",
"display_label": "BYU ID",
"key": true,
"value": "764634873"
},
"credential_id": {
"api_type": "modifiable",
"display_label": "Credential ID",
"key": true,
"value": "ib37"
},
"credential_type": {
"api_type": "modifiable",
"description": "Authentication Credential Provider is ldap.byu.edu",
"display_label": "Credential Type",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Credentials was last updated when?",
"value": "2014-05-11T13:45:53.20Z"
},
"links": {
"credentials__associate": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/:credential_type,:credential_id",
"method": "PUT",
"rel": "credentials__associate"
},
"credentials__info": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "GET",
"rel": "self"
},
"credentials__modify": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "PUT",
"rel": "credentials__modify"
},
"credentials__remove": {
"href": "https://api.byu.edu/cesapi/identitieslite/v1/764634873/credentials/NET_ID,ib37",
"method": "DELETE",
"rel": "credentials__modify"
}
},
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.20Z"
},
"validation_response": {
"response": "Successful",
"return_code": 200
}
},
"scoped_affiliation": {
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Credential was last updated by whom?",
"value": "764634873"
},
"user_name": {
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
}
}
]
}
} - basic: basic
-
- credentials: credentials
-
Information required to create a new Identity - at least one credential is required
{
"created_by_id": "764634873",
"credential_id": "ib37",
"credential_type": "NET_ID",
"date_time_created": "2014-05-11T13:45:53.20Z",
"date_time_updated": "2014-05-11T13:45:53.20Z",
"email_address": "bugsbunny22@gmail.com",
"first_name": "Bugs",
"middle_name": "Bunny",
"person_id": "585241162",
"phone_number": "8014222507",
"preferred_first_name": "Bugs",
"preferred_surname": "Ithaca",
"scoped_affiliation": "student@byui.edu",
"suffix": "Esq.",
"surname": "Ithaca",
"texts_okay": "N",
"updated_by_id": "764634873",
"user_name": "ib37"
} - byu_id: string
-
- person_id: string
-
- surname: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- first_name: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- middle_name: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- suffix: string (1 to 10 chars) , must match ^( |Sr|SR|JR|Jr|M{0,4}(CM|CD|D?C{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3}))$
-
Generational suffix for name: Roman Numeral, JR, SR, Jr, or Sr
- preferred_surname: string (up to 40 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- preferred_first_name: string (up to 25 chars) , must match ^(?=.*?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
-
- email_address: string
-
- phone_number: string
-
- texts_okay: string
-
- created_by_id: string , must match ^([]{0}|[0-9]{9})$
-
- date_time_created: string (date-time)
-
- updated_by_id: string , must match ^([]{0}|[0-9]{9})$
-
- date_time_updated: string (date-time)
-
- credential_id: string
-
- credential_type: string
-
- user_name: string
-
- scoped_affiliation: string
-
Legal Middle Name(s)
{
"api_type": "modifiable",
"display_label": "Middle Names",
"value": "Bunny"
} - value: string (up to 40 chars)
-
- api_type: string , x ∈ { modifiable (default) , read-only }
-
- display_label: string Middle Name
-
Complete Legal Name - First Name First
{
"api_type": "derived",
"display_label": "Name (First Name First)",
"value": "Bugs Bunny Ithaca"
} - value: string (up to 132 chars)
-
- api_type: string , x ∈ { derived (default) }
-
- display_label: string Name (First Name First)
-
Complete Legal Name - Last Name First
{
"api_type": "derived",
"display_label": "Name (Last Name First)",
"value": "Ithaca, Bugs Bunny"
} - value: string (up to 133 chars)
-
- api_type: string , x ∈ { derived (default) }
-
- display_label: string Name (Last Name First)
-
AIM Person ID
{
"api_type": "system",
"display_label": "AIM Person ID",
"value": "585241162"
} - value: string (up to 9 chars)
-
- api_type: string , x ∈ { system (default) }
-
- display_label: string AIM Person ID
-
Phone Number
{
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
} - value: string
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- display_label: string Phone Number
-
Preferred First Name
{
"api_type": "modifiable",
"display_label": "Preferred First Name",
"value": "Bugs"
} - value: string (up to 25 chars)
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- display_label: string Preferred First Name
-
Complete preferred name - first name first
{
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
} - value: string (up to 100 chars)
-
- api_type: string , x ∈ { derived (default) }
-
- display_label: string Preferred Name
-
Preferred Surname
{
"api_type": "modifiable",
"display_label": "Preferred Surname",
"value": "Ithaca"
} - value: string (up to 40 chars)
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- display_label: string Preferred Surname
-
Legal First-Middle-etc Name (everything except for the Surname)
{
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
} - value: string (up to 80 chars)
-
- api_type: string , x ∈ { derived (default) }
-
- display_label: string First/Middle Names
-
The Scoped Affiliation associated with the Credential
{
"api_type": "modifiable",
"display_label": "Scoped Affiliation",
"value": "student@byui.edu"
} - value: string
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- display_label: string Credential Name
-
- cache: object
-
If data is from live source, value will be null, otherwise it will be date-time of cache
- date_time: string (date-time)
-
- validation_response: validation_response
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- max_page_size: integer
-
Legal Suffix added to the Legal Name
{
"api_type": "modifiable",
"display_label": "Name Suffix",
"value": "Esq."
} - value: string (up to 10 chars)
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- display_label: string Name Suffix
-
Legal Surname
{
"api_type": "modifiable",
"display_label": "Surname",
"value": "Ithaca"
} - value: string (up to 40 chars)
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- display_label: string Surname
-
Phone Number accepts text messages
{
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
} - value: string
-
- description: string
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- display_label: string Phone accepts text messages?
-
- field_sets_returned: string[]
-
string , x ∈ { basic , ap_ib_classes , application_actions , application_deliverables , biographical_classifications , college_summaries , credentials , criminal_records , emergency_contacts , endorsements , essays , extra_curricular_activities , file_notes , flags , government_records , high_school_summaries , home_addresses , institute_summaries , international_records , missions , personal_records , phones , recommendations , religious_records , school_selections , seminary_summaries , test_scores } - field_sets_available: string[]
-
string , x ∈ { basic , ap_ib_classes , application_actions , application_deliverables , biographical_classifications , college_summaries , credentials , criminal_records , emergency_contacts , endorsements , essays , extra_curricular_activities , file_notes , flags , government_records , high_school_summaries , home_addresses , institute_summaries , international_records , missions , personal_records , phones , recommendations , religious_records , school_selections , seminary_summaries , test_scores } - field_sets_default: string[]
-
string , x ∈ { basic } - contexts_available: object
-
Contexts available for the Undergraduate Application resource
- application_controls: string[]
-
string , x ∈ { basic , application_actions , application_deliverables , school_selections } - scoring_elements: string[]
-
string , x ∈ { basic , essays , extra_curricular_activities , recommendations }
Who last updated the Identity?
{
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Identity last updated by?",
"value": "764634873"
} - value: string
-
- description: string
-
- api_type: string , x ∈ { system (default) }
-
- display_label: string Identity last updated by?
-
The Credential used for authentication, ie. net_id or user_id
{
"api_type": "modifiable",
"display_label": "User Name",
"value": "ib37"
} - value: string
-
- api_type: string , x ∈ { modifiable , read-only (default) }
-
- display_label: string Credential Name
-
Service Path:
/cesapi/identitieslite
Domain or University API:
/cesapi/identitieslite
