IdentityPersonIdentityCreation
This service creates and maintains identities in the Person (PRO) System.
Base URL: /domains/legacy/identity/person/identitycreation
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/ | POST | Prepare to create an identity, or create an identity. |
/documentation | GET | service definition |
/{net_id} | POST | Change or Reset a password, or change Security Questions and Answers |
Paths
Prepare to create an identity, or create an identity.
rest_of_name | Rest of created identity's name | query | string | |
surname | Surname of new identity | query | string | |
preferred_first_name | The preferred name for person to be called by | query | string | |
suffix | Optional suffix | query | string | |
gender | Gender of person | query | string | |
date_of_birth | When the person was born -> DD MM YYYY | query | string | |
ssn | Social Security Number | query | string | |
first_year_attended | The first year the person attended at BYU | query | string | |
highest_degree_earned | The highest degree person has earned | query | string | |
net_id | Individual identifier chosen by person | query | string | |
validate_net_id | Validate the net id | query | string | |
Email of the person | query | string | ||
password | Password to access person's identity | query | string | |
security_question_1 | First security question | query | string | |
security_question_2 | Second security question | query | string | |
security_answer_1 | First security answer | query | string | |
security_answer_2 | Second security answer | query | string | |
person_id | Individual person identifier | query | string | |
generate_person_id | Generate a individual person identifier | query | string | |
byu_id | Individual person identifier | query | string | |
verification_answer | Designated verification answer | query | string | |
answer_number | The number of the answer | query | string | |
verification_password | Designated verification password | query | string | |
email_password | Password associated with the email | query | string | |
get_match_details | Get match details | query | string | |
admin_mode | Admin mode | query | string | |
try_to_match | try to match | query | string | |
create_person | Create a person | query | string | |
create_net_id | Create a net id | query | string | |
get_suggested_net_id_list | Get suggested net id list | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
POST /{net_id}
Tags: IdentityCreationServiceChange or Reset a password, or change Security Questions and Answers
net_id | string -> | path | string | |
password | Password to access person's identity | query | string | |
security_question_1 | First security question | query | string | |
security_question_2 | Second security question | query | string | |
security_answer_1 | First security answer | query | string | |
security_answer_2 | Second security answer | query | string | |
person_id | Individual person identifier | query | string | |
verification_answer | Designated verification answer | query | string | |
answer_number | The number of the answer | query | string | |
verification_password | Designated verification password | query | string | |
email_password | Password associated with the email | query | string | |
get_match_details | Get match details | query | string | |
admin_mode | Admin mode | query | string | |
try_to_match | try to match | query | string | |
reset_password | Reset the password | query | string | |
update_security | Update security | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Schema definitions
- WebService: object
-
- name: string
-
- operations: operations
-
- errors: errors
-
- httpStatusCodes: httpStatusCodes
-