{"docs":{"name":"XSEDE Identity Service","info":"\n\u003cp\u003eEach HTTP request must have the following request headers set:\u003c/p\u003e\n\n\u003cpre\u003eXA-REQUESTER: requester  -- XRAS will set this to XRAS\nXA-API-KEY:   api-key\u003c/pre\u003e\n","copyright":null,"doc_url":"/apidoc/1.0","api_url":"","resources":{"people":{"doc_url":"/apidoc/1.0/people","id":"people","api_url":"","name":"People","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/people/get_people","name":"get_people","apis":[{"api_url":"/profiles/v1/people","http_method":"GET","short_description":"get all people","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis returns an array of all of the people in the identity service.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /profiles/v1/people\n[\n  {\"username\":\"alphaklaus\", \"firstName\": ... },\n  {\"username\":\"user_132\", \"firstName\": ... },\n  {\"username\":\"user_456\", \"firstName\": ... },\n  ...\n  {\"username\":\"zombiedust\", \"firstName\": ... }\n]\n\n\nOptionally specify ?with_allocations=1 to only include\npeople with active allocations:\nGET /profiles/v1/people?with_allocations=1\n[\n  {\"username\":\"activeUser\", \"firstName\": ... },\n  {\"username\":\"activeUser2\", \"firstName\": ... },\n]\n"],"metadata":null,"see":[{"link":"/apidoc/1.0/people/get_person","description":"GET /profiles/v1/people/:username for format details"}],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/people/get_person","name":"get_person","apis":[{"api_url":"/profiles/v1/people/\u003cusername\u003e","http_method":"GET","short_description":"get the specified person","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /profiles/v1/people/mshapiro\n{\n    \"username\": \"mshapiro\",\n    \"firstName\": \"Michael\",\n    \"middleName\": \"Q\",\n    \"lastName\": \"Shapiro\",\n    \"isSuspended\": false,\n    \"isArchived\": false,\n    \"organizationName\": \"National Center for Supercomputing Applications\",\n    \"organizationId\": 844,\n    \"nsfStatusCodeName\": \"Center Researcher Staff\",\n    \"nsfStatusCodeId\": 2,\n    \"countryName\": \"United States\",\n    \"countryId\": 210,\n    \"work_phone\": \"217-555-5555\",\n    \"email\": \"shapiro2@illinois.edu\",\n    \"citizenships\":[\n        {\n            \"countryName\": \"United States\",\n            \"countryId\": 210\n        }\n    ],\n}\n\nor with optional ?resources=1 parameter:\n\nGET /profiles/v1/people/mshapiro?resources=1\n{\n    \"username\": \"mshapiro\",\n    \"firstName\": \"Michael\",\n    \"middleName\": \"Q\",\n    \"lastName\": \"Shapiro\",\n    \"isSuspended\": false,\n    \"isArchived\": false,\n    \"organizationName\": \"National Center for Supercomputing Applications\",\n    \"organizationId\": 844,\n    \"nsfStatusCodeName\": \"Center Researcher Staff\",\n    \"nsfStatusCodeId\": 2,\n    \"countryName\": \"United States\",\n    \"countryId\": 210,\n    \"work_phone\": \"217-555-5555\",\n    \"email\": \"shapiro2@illinois.edu\",\n    \"citizenships\":[\n        {\n            \"countryName\": \"United States\",\n            \"countryId\": 210\n        }\n    ],\n    \"resources\": [\n        {\n        \"resource_id\": 2932,\n        \"organization_id\": 848,\n        \"resource_name\": \"bridges2-ocean.psc.xsede.org\",\n        \"resource_description\": null,\n        \"resource_type\": \"Disk\",\n        \"rdr_resource_id\": 145122,\n        \"allocable_resource_state\": \"active\",\n        \"activation_start_date\": \"2020-09-01\",\n        \"activation_end_date\": null,\n        \"billable_unit_type\": \"GB\",\n        \"is_active\": true,\n        \"display_name\": \"PSC Bridges-2 Storage (Ocean)\"\n        },\n    ]\n}\n\n\nNOTE: this route should return 404 Not Found if the username does not exist"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/people/get_merged_people","name":"get_merged_people","apis":[{"api_url":"/profiles/v1/merged_people","http_method":"GET","short_description":"get merged people","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis returns an array of all merged people profiles.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /profiles/v1/merged_people?id_offset=10\n\nid_offset is an optional parameter that will specify the minimum id to display\n\n[\n  {\"id\": 10, \"\"keep_username\":\"keeper\", \"delete_username\": \"deprecated\" },\n  {\"id\": 11, \"\"keep_username\":\"alice\", \"delete_username\": \"aliceduplicate\" },\n  {\"id\": 12, \"\"keep_username\":\"bob\", \"delete_username\": \"bob2\" },\n]\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/people/post_person","name":"post_person","apis":[{"api_url":"/profiles/v1/people/\u003cusername\u003e","http_method":"POST","short_description":"create the specified person","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["POST /profiles/v1/people/tolbert2\n\nPost data of the form:\n{\n    \"firstName\": \"Nathan\",\n    \"middleName\": \"Lewis\",\n    \"lastName\": \"Tolbert\",\n    \"organizationId\": 844,\n    \"nsfStatusCodeId\": 2,\n    \"countryId\": 210,\n    \"work_phone\": \"217-244-1769\",\n    \"email\": \"tolbert@illinois.edu\",\n    \"citizenships\":[\n        {\n        \"countryId\": 210\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/people/patch_person","name":"patch_person","apis":[{"api_url":"/profiles/v1/people/\u003cusername\u003e","http_method":"PATCH","short_description":"update the specified person","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["PATCH /profiles/v1/people/mshapiro\n\nSend body data that is a subset of below, including\nonly fields that should be changed:\n{\n    \"firstName\": \"Nathan\",\n    \"middleName\": \"Lewis\",\n    \"lastName\": \"Tolbert\",\n    \"organizationId\": 844,\n    \"nsfStatusCodeId\": 2,\n    \"countryId\": 210,\n    \"work_phone\": \"217-244-1769\",\n    \"email\": \"tolbert@illinois.edu\",\n    \"agreementTime\":\"1715026568\",\n    \"citizenships\":[\n        {\n        \"countryId\": 210\n        }\n    ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/people/suspend_person","name":"suspend_person","apis":[{"api_url":"/profiles/v1/suspend/\u003cusername\u003e","http_method":"POST","short_description":"suspend the specified user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["POST /profiles/v1/suspend/(username to suspend)\n\nSend body data that includes a comment and the person who is\nentering the suspension into the system:\n{\n    \"comments\": \"Person is a hacker\",\n    \"entered_by\": \"tolbert\"\n}\n\nReturns a 200 status on success, with no body."],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"countries":{"doc_url":"/apidoc/1.0/countries","id":"countries","api_url":"","name":"Countries","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/countries/get_countries","name":"get_countries","apis":[{"api_url":"/profiles/v1/countries","http_method":"GET","short_description":"get all countries","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis returns an array of all of the countries in the profile service.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /profiles/v1/countries\n[\n    {\n    \"countryId\": 1,\n    \"countryName\": \"Afghanistan\",\n    \"nsfCode\": \"9AF\",\n    \"isReconciled\": true\n    },\n    {\n    \"countryId\": 2,\n    \"countryName\": \"Albania\",\n    \"nsfCode\": \"9AL\",\n    \"isReconciled\": true\n    },\n    {\n    \"countryId\": 3,\n    \"countryName\": \"Algeria\",\n    \"nsfCode\": \"9AG\",\n    \"isReconciled\": true\n    },\n    {\n    \"countryId\": 4,\n    \"countryName\": \"Andorra\",\n    \"nsfCode\": \"9AN\",\n    \"isReconciled\": true\n    },\n    {\n    \"countryId\": 5,\n    \"countryName\": \"Angola\",\n    \"nsfCode\": \"9AO\",\n    \"isReconciled\": true\n    },\n    {\n    \"countryId\": 6,\n    \"countryName\": \"Anguilla\",\n    \"nsfCode\": \"9AV\",\n    \"isReconciled\": true\n    },\n    {\n    \"countryId\": 7,\n    \"countryName\": \"Antigua and Barbuda\",\n    \"nsfCode\": \"9AC\",\n    \"isReconciled\": true\n    },\n]\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"nsf_status_codes":{"doc_url":"/apidoc/1.0/nsf_status_codes","id":"nsf_status_codes","api_url":"","name":"Nsf_status_codes","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/nsf_status_codes/get_nsf_status_codes","name":"get_nsf_status_codes","apis":[{"api_url":"/profiles/v1/nsf_statuses","http_method":"GET","short_description":"get all nsf academic statuses","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis returns an array of all of the nsf academic statuses in the profile service.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /profiles/v1/nsf_status_codes\n[\n    {\"nsfStatusCodeId\":1,\"nsfStatusCodeName\":\"Center Non-Researcher Staff\",\"nsfStatusCode\":\"CN\"},\n    {\"nsfStatusCodeId\":2,\"nsfStatusCodeName\":\"Center Researcher Staff\",\"nsfStatusCode\":\"CR\"},\n    {\"nsfStatusCodeId\":3,\"nsfStatusCodeName\":\"Faculty\",\"nsfStatusCode\":\"F\"},\n    {\"nsfStatusCodeId\":4,\"nsfStatusCodeName\":\"Government User\",\"nsfStatusCode\":\"G\"},\n    {\"nsfStatusCodeId\":5,\"nsfStatusCodeName\":\"Graduate Student\",\"nsfStatusCode\":\"GS\"},\n    {\"nsfStatusCodeId\":6,\"nsfStatusCodeName\":\"High School Student\",\"nsfStatusCode\":\"HS\"},\n    {\"nsfStatusCodeId\":7,\"nsfStatusCodeName\":\"High School Teacher\",\"nsfStatusCode\":\"HT\"},\n    {\"nsfStatusCodeId\":8,\"nsfStatusCodeName\":\"Industrial User\",\"nsfStatusCode\":\"I\"},\n    {\"nsfStatusCodeId\":9,\"nsfStatusCodeName\":\"Unaffiliated User\",\"nsfStatusCode\":\"N\"},\n    {\"nsfStatusCodeId\":10,\"nsfStatusCodeName\":\"Nonprofit User\",\"nsfStatusCode\":\"NP\"},\n    {\"nsfStatusCodeId\":11,\"nsfStatusCodeName\":\"Other User\",\"nsfStatusCode\":\"O\"},\n    {\"nsfStatusCodeId\":12,\"nsfStatusCodeName\":\"Postdoctorate\",\"nsfStatusCode\":\"PD\"},\n    {\"nsfStatusCodeId\":13,\"nsfStatusCodeName\":\"Undergraduate Student\",\"nsfStatusCode\":\"UG\"},\n    {\"nsfStatusCodeId\":14,\"nsfStatusCodeName\":\"Unknown\",\"nsfStatusCode\":\"UK\"},\n    {\"nsfStatusCodeId\":15,\"nsfStatusCodeName\":\"University Non-Research Staff\",\"nsfStatusCode\":\"UN\"},\n    {\"nsfStatusCodeId\":16,\"nsfStatusCodeName\":\"University Research Staff (excluding postdoctorates)\",\"nsfStatusCode\":\"UR\"}\n]\n\n\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"organizations":{"doc_url":"/apidoc/1.0/organizations","id":"organizations","api_url":"","name":"Organizations","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/1.0/organizations/get_organizations","name":"get_organizations","apis":[{"api_url":"/profiles/v1/organizations","http_method":"GET","short_description":"get all organizations","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis returns an array of all of the organizations in the profile service. Optionally, filter organizations created after a specific date by using the ‘updated_after’ parameter.\u003c/p\u003e\n","errors":[],"params":[{"name":"updated_after","full_name":"updated_after","description":"\n\u003cp\u003eFilter organizations updated after this date (ISO 8601 format)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["GET /profiles/v1/organizations\n[\n    {\n        \"organization_id\": 2735,\n        \"org_type_id\": 4,\n        \"organization_abbrev\": \"Exa Corp.\",\n        \"organization_name\": \"Exa Corporation\",\n        \"organization_url\": null,\n        \"organization_phone\": null,\n        \"nsf_org_code\": \"T103902\",\n        \"is_reconciled\": true,\n        \"amie_name\": null,\n        \"country_id\": 210,\n        \"state_id\": 23,\n        \"latitude\": \"42.497508\",\n        \"longitude\": \"-71.234265\",\n        \"is_msi\": null,\n        \"is_active\": true,\n        \"carnegieCategories\": [],\n        \"state\": \"Massachusetts\",\n        \"country\": \"United States\",\n        \"org_type\": \"Industrial\"\n    },\n    {\n        \"organization_id\": 1231,\n        \"org_type_id\": 6,\n        \"organization_abbrev\": \"Quetzal Computationa\",\n        \"organization_name\": \"Quetzal Computational Associates\",\n        \"organization_url\": null,\n        \"organization_phone\": null,\n        \"nsf_org_code\": \"6103790\",\n        \"is_reconciled\": true,\n        \"amie_name\": null,\n        \"country_id\": null,\n        \"state_id\": null,\n        \"latitude\": \"35.124329\",\n        \"longitude\": \"-106.586556\",\n        \"is_msi\": null,\n        \"is_active\": false,\n        \"carnegieCategories\": [],\n        \"state\": null,\n        \"country\": null,\n        \"org_type\": \"Other or Unknown\"\n    }\n]\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/1.0/organizations/merged_organizations","name":"merged_organizations","apis":[{"api_url":"/profiles/v1/merged_organizations","http_method":"GET","short_description":"get a list of merged organizations","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis returns an array of all merged organizations\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /profiles/v1/merged_people?after=2016-11-07\n\nafter is an optional timestamp parameter\n\n[\n    {\"id\":1,\"keep_organization_id\":569,\"delete_organization_id\":3511,\"keep_org_code\":\"0087718\",\"delete_org_code\":\"XD3511\",\"ts\":\"2016-11-08T20:34:15.592Z\"},\n    {\"id\":2,\"keep_organization_id\":105,\"delete_organization_id\":4249,\"keep_org_code\":\"0013177\",\"delete_org_code\":\"XD4249\",\"ts\":\"2016-11-08T20:36:16.215Z\"},\n    {\"id\":3,\"keep_organization_id\":561,\"delete_organization_id\":4111,\"keep_org_code\":\"0087312\",\"delete_org_code\":\"XD4111\",\"ts\":\"2016-11-08T20:37:30.092Z\"}\n],"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}}}}