{"apiVersion":"5.1.1","swaggerVersion":"1.1","basePath":"https://api.composer.nprstations.org/v1","resourcePath":"/account","apis":[{"path":"/account/current","description":"Get the Current User","operations":[{"parameters":[],"httpMethod":"GET","notes":"This endpoint provides the ability to retrieve the currently authenticated user.","errorResponses":[],"nickname":"current","summary":"Current","customFields":{"description":"Get the Current User","path":"/account/current","method":"GET","params":[],"preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/account/search","description":"Search User Accounts","operations":[{"parameters":[{"name":"id","description":"User ID","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"username","description":"User Name","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"limit","description":"Number of Results to Return, Default is 10","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"ucs","description":"Find with access a specific UCS ID (Use 'any' to find with '*').","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"program","description":"Find with a specific UCS access or Program ID (Use 'any' to find '*'')","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"email","description":"Find with a specific email address.","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"role","description":"User Role (Admin, Host)","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["any","admin","host","super"]},"defaultValue":"any","paramType":"query"},{"name":"match","description":"Type of Text Search (Defaults to Exact)","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["startswith","exact"]},"defaultValue":"startswith","paramType":"query"}],"httpMethod":"GET","notes":"Search accounts.","errorResponses":[],"nickname":"search","summary":"Search","customFields":{"description":"Search User Accounts","path":"/account/search","method":"GET","params":[{"name":"id","description":"User ID","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"username","description":"User Name","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"limit","description":"Number of Results to Return, Default is 10","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"ucs","description":"Find with access a specific UCS ID (Use 'any' to find with '*').","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"program","description":"Find with a specific UCS access or Program ID (Use 'any' to find '*'')","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"email","description":"Find with a specific email address.","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"role","description":"User Role (Admin, Host)","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["any","admin","host","super"]},"defaultValue":"any","paramType":"query"},{"name":"match","description":"Type of Text Search (Defaults to Exact)","dataType":"string","required":false,"allowMultiple":true,"allowableValues":{"valueType":"LIST","values":["startswith","exact"]},"defaultValue":"startswith","paramType":"query"}],"responseClass":"account","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"account"}]},{"path":"/account/{account}","description":"Get a User Account","operations":[{"parameters":[{"name":"account","description":"Username","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This endpoint retrieves a user's account","errorResponses":[],"nickname":"get","summary":"Get","customFields":{"description":"Get a User Account","path":"/account/{account}","method":"GET","params":[{"name":"account","description":"Username","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/account","description":"Create a User Account","operations":[{"parameters":[{"name":"body","description":"Account Object","dataType":"Account","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"POST","notes":"This endpoint provides the ability to create a new user account.","errorResponses":[],"nickname":"create","summary":"Create","customFields":{"description":"Create a User Account","path":"/account","method":"POST","params":[{"name":"body","description":"Account Object","dataType":"Account","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"account","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"account"}]},{"path":"/account","description":"Update a User Account","operations":[{"parameters":[{"name":"body","description":"Account Object","dataType":"Account","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"PUT","notes":"This endpoint provides the ability to update a new user account.","errorResponses":[],"nickname":"update","summary":"Update","customFields":{"description":"Update a User Account","path":"/account","method":"PUT","params":[{"name":"body","description":"Account Object","dataType":"Account","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"account","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"account"}]},{"path":"/account/{account}","description":"Delete a User Account","operations":[{"parameters":[{"name":"account","description":"Account ID","dataType":"Enter the IDs of the account you want to delete.","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"DELETE","notes":"This endpoint provides the ability to delete a user account.","errorResponses":[],"nickname":"delete","summary":"Delete","customFields":{"description":"Delete a User Account","path":"/account/{account}","method":"DELETE","params":[{"name":"account","description":"Account ID","dataType":"Enter the IDs of the account you want to delete.","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"account","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"account"}]},{"path":"/account/{account}/managedaccounts","description":"Get the users that the given user can administer.","operations":[{"parameters":[{"name":"account","description":"User ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Number of Results to Return, Default is 10","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"page","description":"Page to start on, Default is 1","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"term","description":"Search Term","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"ucs","description":"UCS ID","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"}],"httpMethod":"GET","notes":"Get the users that can read the UCSes of which the given user is a station manager or better.","errorResponses":[],"nickname":"managed-accounts","summary":"Managed Accounts","customFields":{"description":"Get the users that the given user can administer.","path":"/account/{account}/managedaccounts","method":"GET","params":[{"name":"account","description":"User ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Number of Results to Return, Default is 10","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"page","description":"Page to start on, Default is 1","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"term","description":"Search Term","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"},{"name":"ucs","description":"UCS ID","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"","paramType":"query"}],"responseClass":"","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]}],"models":{"Account":{"id":"Account","properties":{"username":{"type":"string","description":"Username (no spaces, will be converted to lowercase)","required":false},"password":{"type":"string","description":"Password. Minimum of 10 characters (No Spaces, AZaz09).","required":false},"email":{"type":"string","description":"Email Address.","required":false},"role":{"type":"string","description":"Role. e.g. super, admin, host, readonly","required":false},"domains":{"type":"domains","description":"The domains to which the account's role applies.","required":false}}},"domains":{"id":"domains","properties":{"ucs":{"type":"LIST","description":"The ids of the UCSes to which the role applies.","required":false},"program":{"type":"LIST","description":"The ids of the program to which the role applies.","required":false}}}}}