diff --git a/navbar.js b/navbar.js index bb073aef3..b26f4f92d 100644 --- a/navbar.js +++ b/navbar.js @@ -52,6 +52,21 @@ module.exports = { }, ], }, + { + type: 'dropdown', + label: 'NERM', + position: 'left', + items: [ + {to: '#', label: 'API Specifications', className: 'navbar__section'}, + {to: '/nerm/api', label: 'NERM APIs', className: 'indent'}, + {to: '#', label: 'External Links', className: 'navbar__section'}, + { + href: 'https://documentation.sailpoint.com', + label: 'Product Documentation', + className: 'indent', + } + ] + }, { position: 'left', label: 'Blog', diff --git a/package.json b/package.json index d4a608686..ee1c3aeaa 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,8 @@ "clean-api-docs": "docusaurus clean-api-docs", "gen-api-docs:version": "docusaurus gen-api-docs:version", "clean-api-docs:version": "docusaurus clean-api-docs:version", - "gen-api-docs-all": "docusaurus gen-api-docs idn_v3 --plugin-id idn-api && docusaurus gen-api-docs idn_beta --plugin-id idn-api && docusaurus gen-api-docs iiq --plugin-id iiq-api", - "clean-api-docs-all": "docusaurus clean-api-docs idn_v3 --plugin-id idn-api && docusaurus clean-api-docs idn_beta --plugin-id idn-api && docusaurus clean-api-docs iiq --plugin-id iiq-api", + "gen-api-docs-all": "docusaurus gen-api-docs idn_v3 --plugin-id idn-api && docusaurus gen-api-docs idn_beta --plugin-id idn-api && docusaurus gen-api-docs iiq --plugin-id iiq-api && docusaurus gen-api-docs nerm --plugin-id nerm-api", + "clean-api-docs-all": "docusaurus clean-api-docs idn_v3 --plugin-id idn-api && docusaurus clean-api-docs idn_beta --plugin-id idn-api && docusaurus clean-api-docs iiq --plugin-id iiq-api && docusaurus clean-api-docs nerm --plugin-id nerm-api", "rebuild-docs": "npm run clean-api-docs-all && npm run gen-api-docs-all" }, "dependencies": { diff --git a/plugins.js b/plugins.js index 552050062..da448e3b0 100644 --- a/plugins.js +++ b/plugins.js @@ -38,6 +38,20 @@ module.exports = [ docItemComponent: '@theme/ApiItem', }, ], + [ + '@docusaurus/plugin-content-docs', + { + id: 'nerm', + path: 'products/nerm', + routeBasePath: 'nerm', + editUrl: + 'https://github.com/sailpoint-oss/developer-community-site/edit/main/', + showLastUpdateAuthor: true, + showLastUpdateTime: true, + sidebarPath: require.resolve('./products/nerm/sidebar.js'), + docItemComponent: '@theme/ApiItem', + }, + ], [ '@docusaurus/plugin-google-gtag', { @@ -93,4 +107,22 @@ module.exports = [ }, }, ], + [ + 'docusaurus-plugin-openapi-docs', + { + id: 'nerm-api', + docsPluginId: 'nerm', + config: { + nerm: { + specPath: 'static/api-specs/nerm/openapi.yaml', + outputDir: 'products/nerm/api', + sidebarOptions: { + groupPathsBy: 'tag', + categoryLinkSource: 'tag', + }, + template: 'api.mustache', + }, + }, + }, + ] ]; diff --git a/products/nerm/api/delete-attribute-option.api.mdx b/products/nerm/api/delete-attribute-option.api.mdx new file mode 100644 index 000000000..005d1b0fe --- /dev/null +++ b/products/nerm/api/delete-attribute-option.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-attribute-option +sidebar_label: Delete a option based attribute value by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAttributeOption","description":"Delete a option based attribute value by id","tags":["Attribute Options"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Confirmation of a deleted object","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"string","default":"The option '{Option Value}' has been deleted"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/ne_attribute_options/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete a option based attribute value by id","description":{"content":"Delete a option based attribute value by id","type":"text/plain"},"url":{"path":["ne_attribute_options",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a option based attribute value by id' (delete-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a option based attribute value by id + + + +Delete a option based attribute value by id + +
Path Parameters
+ +Confirmation of a deleted object + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/delete-profile-type.api.mdx b/products/nerm/api/delete-profile-type.api.mdx new file mode 100644 index 000000000..874bca2fd --- /dev/null +++ b/products/nerm/api/delete-profile-type.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-profile-type +sidebar_label: Delete profile type +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteProfileType","description":"Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed.","tags":["Profile Types"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Info about the operation","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"description":"A message confirming the operation","example":"object deleted"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/profile_types/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete profile type","description":{"content":"Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed.","type":"text/plain"},"url":{"path":["profile_types",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete profile type' (delete-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete profile type + + + +Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. + +
Path Parameters
+ +Info about the operation + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/delete-profiles.api.mdx b/products/nerm/api/delete-profiles.api.mdx new file mode 100644 index 000000000..c591289e0 --- /dev/null +++ b/products/nerm/api/delete-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-profiles +sidebar_label: Delete multiple profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteProfiles","description":"Delete multiple profiles","tags":["Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"my profile","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","created_at":"2023-05-01T09:12:28Z","updated_at":"2023-05-01T09:12:28Z","attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/profiles","jsonRequestBodyExample":{"profiles":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete multiple profiles","description":{"content":"Delete multiple profiles","type":"text/plain"},"url":{"path":["profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete multiple profiles' (delete-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete multiple profiles + + + +Delete multiple profiles + +
Request Body required
    profiles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
    • job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/delete-role-profile.api.mdx b/products/nerm/api/delete-role-profile.api.mdx new file mode 100644 index 000000000..8d44ef87f --- /dev/null +++ b/products/nerm/api/delete-role-profile.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-role-profile +sidebar_label: Delete a role profile assignment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteRoleProfile","description":"Delete a role profile assignment","tags":["Role Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Role profile was destroyed","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/role_profile/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete a role profile assignment","description":{"content":"Delete a role profile assignment","type":"text/plain"},"url":{"path":["role_profile",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a role profile assignment' (delete-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a role profile assignment + + + +Delete a role profile assignment + +
Path Parameters
+ +Role profile was destroyed + +
Schema
  • object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/delete-user-profile.api.mdx b/products/nerm/api/delete-user-profile.api.mdx new file mode 100644 index 000000000..97292f9c3 --- /dev/null +++ b/products/nerm/api/delete-user-profile.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-user-profile +sidebar_label: Delete a user profile assignment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteUserProfile","description":"Delete a user profile assignment","tags":["User Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"User profile was destroyed","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/user_profile/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete a user profile assignment","description":{"content":"Delete a user profile assignment","type":"text/plain"},"url":{"path":["user_profile",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a user profile assignment' (delete-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a user profile assignment + + + +Delete a user profile assignment + +
Path Parameters
+ +User profile was destroyed + +
Schema
  • object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/delete-user-role.api.mdx b/products/nerm/api/delete-user-role.api.mdx new file mode 100644 index 000000000..1631cd487 --- /dev/null +++ b/products/nerm/api/delete-user-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-user-role +sidebar_label: Delete a user role assignment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteUserRole","description":"Delete a user role assignment","tags":["User Roles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"User role was destroyed","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/user_role/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete a user role assignment","description":{"content":"Delete a user role assignment","type":"text/plain"},"url":{"path":["user_role",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a user role assignment' (delete-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a user role assignment + + + +Delete a user role assignment + +
Path Parameters
+ +User role was destroyed + +
Schema
  • object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/delete-user.api.mdx b/products/nerm/api/delete-user.api.mdx new file mode 100644 index 000000000..e9c52e406 --- /dev/null +++ b/products/nerm/api/delete-user.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-user +sidebar_label: Delete a user +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteUser","description":"Delete a user","tags":["Users"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Info about the operation","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"description":"A message confirming the operation","example":"object deleted"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"delete","path":"/users/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Delete a user","description":{"content":"Delete a user","type":"text/plain"},"url":{"path":["users",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a user' (delete-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a user + + + +Delete a user + +
Path Parameters
+ +Info about the operation + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-advanced-search.api.mdx b/products/nerm/api/get-advanced-search.api.mdx new file mode 100644 index 000000000..4cc3f09d5 --- /dev/null +++ b/products/nerm/api/get-advanced-search.api.mdx @@ -0,0 +1,35 @@ +--- +id: get-advanced-search +sidebar_label: Get saved advanced search queries +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAdvancedSearch","description":"Get saved advanced search queries","tags":["Advanced Search"],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"advanced_search":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"the label","type":"string","example":"mylabel"},"condition_rules_attributes":{"description":"The condition rules attributes","type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uuid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileTypeRule"],"example":"ProfileTypeRule"},"comparison_operator":{"description":"The comparison operator","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileStatusRule"],"example":"ProfileStatusRule"},"comparison_operator":{"description":"The comparison operator","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","enum":["Active","Inactive","Leave of absence","Terminated"],"example":"Active"}}},{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"],"example":"TextAreaAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"],"example":"=="},"value":{"description":"The value","type":"string","required":true,"example":"Some value"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition object type","type":"string","required":true,"enum":["DateAttribute"],"example":"DateAttribute"},"condition_object_id":{"description":"The condition object id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_attribute_type":{"description":"The secondary_attribute_type","type":"string","enum":["DateAttribute"],"example":"DateAttribute"},"secondary_attribute_id":{"description":"The secondary_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":[">","<","after","before"],"example":"<"},"value":{"description":"The value to use for comparison","type":"string","required":true,"enum":["Today",""],"example":"Today"},"secondary_value":{"description":"The secondary value","type":"string","enum":["after","before"],"example":"after"},"tertiary_value":{"description":"the tertiary_value","type":"string","example":30}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"],"example":"OwnerSearchAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The comparison_operator","type":"string","required":true,"enum":["include?","exclude?"],"example":"include?"},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["RiskRule"],"example":"RiskRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==",">","<"],"example":"=="},"value":{"description":"Id of the Risk Level being compared against","type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_value":{"description":"The secondary value","type":"string","required":true,"enum":["OverallRisk"],"example":"OverallRisk"}}}]},"example":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"type":"ProfileStatusRule","id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","comparison_operator":"==","value":"Active"}]}}}}}}}}}},"method":"get","path":"/advanced_search","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get saved advanced search queries","description":{"content":"Get saved advanced search queries","type":"text/plain"},"url":{"path":["advanced_search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get saved advanced search queries' (get-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get saved advanced search queries + + + +Get saved advanced search queries + +
+ +Expected response to a valid request + +
Schema
    advanced_search object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    condition_rules_attributes object[]
    + +The condition rules attributes + +
    anyOf= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`, `start_with?`, `end_with?`, `include?`]"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`, `after`, `before`]"} defaultValue={undefined}>`]"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`]"} defaultValue={undefined}>
\ No newline at end of file diff --git a/products/nerm/api/get-attribute-option.api.mdx b/products/nerm/api/get-attribute-option.api.mdx new file mode 100644 index 000000000..95704ca33 --- /dev/null +++ b/products/nerm/api/get-attribute-option.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-attribute-option +sidebar_label: Find option based attribute value by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAttributeOption","description":"Info for a specific option based attribute value","tags":["Attribute Options"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_option":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"the option","type":"string","example":"myoption"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/ne_attribute_options/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find option based attribute value by id","description":{"content":"Info for a specific option based attribute value","type":"text/plain"},"url":{"path":["ne_attribute_options",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find option based attribute value by id' (get-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find option based attribute value by id + + + +Info for a specific option based attribute value + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    ne_attribute_option object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-attribute-options.api.mdx b/products/nerm/api/get-attribute-options.api.mdx new file mode 100644 index 000000000..e4860d012 --- /dev/null +++ b/products/nerm/api/get-attribute-options.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-attribute-options +sidebar_label: Get option based attribute values +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAttributeOptions","description":"Get option based attribute values","tags":["Attribute Options"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"ne_attribute_id","in":"query","description":"ID of an attribute for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_options":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"the option","type":"string","example":"myoption"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/ne_attribute_options","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get option based attribute values","description":{"content":"Get option based attribute values","type":"text/plain"},"url":{"path":["ne_attribute_options"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of an attribute for filtering","type":"text/plain"},"key":"ne_attribute_id","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get option based attribute values' (get-attribute-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get option based attribute values + + + +Get option based attribute values + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    ne_attribute_options object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-attribute.api.mdx b/products/nerm/api/get-attribute.api.mdx new file mode 100644 index 000000000..d50bcecc0 --- /dev/null +++ b/products/nerm/api/get-attribute.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-attribute +sidebar_label: Find attribute data by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAttribute","description":"Info for a specific attribute","tags":["Attributes"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"The label","type":"string","example":"my_attribute"},"description":{"description":"The description","type":"string","example":"This is my attribute"},"tool_tip":{"description":"The tool tip","type":"string","example":"my attribute"},"crypt":{"description":"Should this be encrypted?","type":"boolean","example":true},"archived":{"description":"Is this attribute archived?","type":"boolean","example":false},"archived_on":{"description":"When was this attribute archved","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"created_at":{"description":"The created_at time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"The updated_at time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"date_format":{"description":"The format of the date","type":"string","enum":["mm/dd/yyyy","mm-dd-yyyy","dd/mm/yyyy","dd-mm-yyyy","yyyy/mm/dd","yyyy-mm-dd"],"example":"mm/dd/yyyy"},"selectable_status":{"description":"The selectable_status","type":"string","example":"Active"},"risk_score_setting":{"description":"The risk score setting","type":"string","example":"standard"},"risk_type":{"description":"The risk type","type":"string","example":"inherited"},"ownership_driver":{"description":"The ownership_driver","type":"boolean","example":true},"allow_multiple_selections":{"description":"allow multiple selections","type":"boolean","example":false},"filtered_by_ne_attribute":{"description":"Should this attribute be filtered_by_ne_attribute","type":"boolean","example":false},"filtering_ne_attribute_id":{"description":"The ne_attribute_id to use for filtering","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_filter_id":{"description":"The ne_attribute_id to filter by","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"reverse_association_attribute_id":{"description":"The reverse association ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"The profile_type_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"legacy_id":{"description":"The legacy ID","type":"integer","format":"int32","example":123},"tmp_created_at":{"description":"(Deprecated) The temporary created_at field","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"tmp_updated_at":{"description":"(Deprecated) The temporary updated_at field","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/ne_attributes/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find attribute data by id","description":{"content":"Info for a specific attribute","type":"text/plain"},"url":{"path":["ne_attributes",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find attribute data by id' (get-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find attribute data by id + + + +Info for a specific attribute + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    ne_attribute object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-attributes.api.mdx b/products/nerm/api/get-attributes.api.mdx new file mode 100644 index 000000000..e64019d7e --- /dev/null +++ b/products/nerm/api/get-attributes.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-attributes +sidebar_label: Get attribute data in bulk +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAttributes","description":"This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters","tags":["Attributes"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"label","in":"query","description":"The attribute label to filter by","required":false,"example":"mylabel","schema":{"type":"string"}},{"name":"data_type","in":"query","description":"The attribute data type to filter by","required":false,"schema":{"type":"string","enum":["text field","text area","drop-down","radio buttons","check boxes","date","tags","attachment","profile select","profile search","owner select","owner search","contributor select","contributor search"]},"example":"radio buttons"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"ne_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"The label","type":"string","example":"my_attribute"},"description":{"description":"The description","type":"string","example":"This is my attribute"},"tool_tip":{"description":"The tool tip","type":"string","example":"my attribute"},"crypt":{"description":"Should this be encrypted?","type":"boolean","example":true},"archived":{"description":"Is this attribute archived?","type":"boolean","example":false},"archived_on":{"description":"When was this attribute archved","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"created_at":{"description":"The created_at time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"The updated_at time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"date_format":{"description":"The format of the date","type":"string","enum":["mm/dd/yyyy","mm-dd-yyyy","dd/mm/yyyy","dd-mm-yyyy","yyyy/mm/dd","yyyy-mm-dd"],"example":"mm/dd/yyyy"},"selectable_status":{"description":"The selectable_status","type":"string","example":"Active"},"risk_score_setting":{"description":"The risk score setting","type":"string","example":"standard"},"risk_type":{"description":"The risk type","type":"string","example":"inherited"},"ownership_driver":{"description":"The ownership_driver","type":"boolean","example":true},"allow_multiple_selections":{"description":"allow multiple selections","type":"boolean","example":false},"filtered_by_ne_attribute":{"description":"Should this attribute be filtered_by_ne_attribute","type":"boolean","example":false},"filtering_ne_attribute_id":{"description":"The ne_attribute_id to use for filtering","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_filter_id":{"description":"The ne_attribute_id to filter by","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"reverse_association_attribute_id":{"description":"The reverse association ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"The profile_type_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"legacy_id":{"description":"The legacy ID","type":"integer","format":"int32","example":123},"tmp_created_at":{"description":"(Deprecated) The temporary created_at field","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"tmp_updated_at":{"description":"(Deprecated) The temporary updated_at field","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/ne_attributes","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get attribute data in bulk","description":{"content":"This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters","type":"text/plain"},"url":{"path":["ne_attributes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The attribute label to filter by","type":"text/plain"},"key":"label","value":""},{"disabled":false,"description":{"content":"The attribute data type to filter by","type":"text/plain"},"key":"data_type","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get attribute data in bulk' (get-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get attribute data in bulk + + + +This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    ne_attributes object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-identity-proofing-results.api.mdx b/products/nerm/api/get-identity-proofing-results.api.mdx new file mode 100644 index 000000000..ff0f0c894 --- /dev/null +++ b/products/nerm/api/get-identity-proofing-results.api.mdx @@ -0,0 +1,35 @@ +--- +id: get-identity-proofing-results +sidebar_label: Get identity proofing result data in bulk +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityProofingResults","description":"This endpoint can retrieve identity proofing result data in bulk from Lifecycle","tags":["Identity Proofing Results"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"workflow_session_id","in":"query","description":"Workflow Session ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"result","in":"query","description":"ID Proofing Result to filter by","required":false,"schema":{"type":"string","enum":["pass","fail"]},"example":"fail"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"identity_proofing_results":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"identity_proofing_action_id":{"description":"The identity_proofing_action_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"workflow_session_id":{"description":"the workflow_session_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"the profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"proofing_workflow":{"description":"the proofing workflow id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"result":{"description":"the result of the identity proofing","type":"string","enum":["pending","pass","fail"],"example":"pass"},"proofing_attributes":{"description":"Any additional attributes associated with the proofing","type":"object","additionalProperties":{"type":"string"},"example":{"result":"approve"}},"created_at":{"description":"The created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"The updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}}},"method":"get","path":"/identity_proofing_results","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get identity proofing result data in bulk","description":{"content":"This endpoint can retrieve identity proofing result data in bulk from Lifecycle","type":"text/plain"},"url":{"path":["identity_proofing_results"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Profile ID to filter by","type":"text/plain"},"key":"profile_id","value":""},{"disabled":false,"description":{"content":"Workflow Session ID to filter by","type":"text/plain"},"key":"workflow_session_id","value":""},{"disabled":false,"description":{"content":"ID Proofing Result to filter by","type":"text/plain"},"key":"result","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get identity proofing result data in bulk' (get-identity-proofing-results)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get identity proofing result data in bulk + + + +This endpoint can retrieve identity proofing result data in bulk from Lifecycle + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    identity_proofing_results object[]
    proofing_attributes object
    + +Any additional attributes associated with the proofing + +
  • property name* string
    • _metadata object
\ No newline at end of file diff --git a/products/nerm/api/get-job-status.api.mdx b/products/nerm/api/get-job-status.api.mdx new file mode 100644 index 000000000..f36373c80 --- /dev/null +++ b/products/nerm/api/get-job-status.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-job-status +sidebar_label: Get the status of a bulk job +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getJobStatus","description":"Get the status of a bulk job","tags":["Job Status"],"parameters":[{"name":"job_id","in":"query","description":"The id of the job returned from a POST or PATCH endpoint that resulted in a job being created","required":true,"schema":{"type":"string"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"status":{"type":"string","example":"complete"},"job_type":{"type":"string","example":"import"},"job_data":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","format":"uuid"},"manager_id":{"type":"string","format":"uuid"},"errors":{"type":"array","items":{"type":"string","example":"Validation error for record in job"}}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/job_status","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get the status of a bulk job","description":{"content":"Get the status of a bulk job","type":"text/plain"},"url":{"path":["job_status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The id of the job returned from a POST or PATCH endpoint that resulted in a job being created","type":"text/plain"},"key":"job_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the status of a bulk job' (get-job-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the status of a bulk job + + + +Get the status of a bulk job + +
Query Parameters
+ +Expected response to a valid request + +
Schema
    job_data object[]
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-profile-avatar.api.mdx b/products/nerm/api/get-profile-avatar.api.mdx new file mode 100644 index 000000000..57aecddb1 --- /dev/null +++ b/products/nerm/api/get-profile-avatar.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-profile-avatar +sidebar_label: Retrieves the URL of the profile avatar +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProfileAvatar","description":"Retrieves the URL of the profile avatar","tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profiles/{id}/avatar","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Retrieves the URL of the profile avatar","description":{"content":"Retrieves the URL of the profile avatar","type":"text/plain"},"url":{"path":["profiles",":id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves the URL of the profile avatar' (get-profile-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves the URL of the profile avatar + + + +Retrieves the URL of the profile avatar + +
Path Parameters
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-profile-type.api.mdx b/products/nerm/api/get-profile-type.api.mdx new file mode 100644 index 000000000..473638a2e --- /dev/null +++ b/products/nerm/api/get-profile-type.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-type +sidebar_label: Find profile type by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProfileType","description":"Find profile type by id","tags":["Profile Types"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile_type":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile type"},"bypass_dup_protection":{"description":"bypass duplicate protection?","type":"boolean","example":false},"archived":{"description":"is this profile type archived?","type":"boolean","example":false},"permitted_role_ids":{"description":"permitted role_ids for this profile_type","type":"array","items":{"type":"string","format":"uuid"},"example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df92"]},"profile_type_dup_attributes":{"description":"The profile type duplicate attributes","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h"}]},"profile_type_namings":{"description":"the profile type namings","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"order":{"description":"the order","type":"integer","format":"int32","minimum":0,"example":0}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h","order":0}]}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profile_types/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find profile type by id","description":{"content":"Find profile type by id","type":"text/plain"},"url":{"path":["profile_types",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find profile type by id' (get-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find profile type by id + + + +Find profile type by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    profile_type object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_dup_attributes object[]
    + +The profile type duplicate attributes + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_namings object[]
    + +the profile type namings + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-profile-types.api.mdx b/products/nerm/api/get-profile-types.api.mdx new file mode 100644 index 000000000..4f2327d27 --- /dev/null +++ b/products/nerm/api/get-profile-types.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-types +sidebar_label: Get profile types +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProfileTypes","description":"Get option based attribute values","tags":["Profile Types"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"name","in":"query","description":"object name for filtering","required":false,"schema":{"type":"string"},"example":"objectname"},{"name":"archived","in":"query","description":"Filter by archive status","required":false,"schema":{"type":"boolean","default":false},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile_types":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile type"},"bypass_dup_protection":{"description":"bypass duplicate protection?","type":"boolean","example":false},"archived":{"description":"is this profile type archived?","type":"boolean","example":false},"permitted_role_ids":{"description":"permitted role_ids for this profile_type","type":"array","items":{"type":"string","format":"uuid"},"example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df92"]},"profile_type_dup_attributes":{"description":"The profile type duplicate attributes","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h"}]},"profile_type_namings":{"description":"the profile type namings","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"order":{"description":"the order","type":"integer","format":"int32","minimum":0,"example":0}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h","order":0}]}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profile_types","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get profile types","description":{"content":"Get option based attribute values","type":"text/plain"},"url":{"path":["profile_types"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"object name for filtering","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter by archive status","type":"text/plain"},"key":"archived","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get profile types' (get-profile-types)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get profile types + + + +Get option based attribute values + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    profile_types object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_dup_attributes object[]
    + +The profile type duplicate attributes + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_namings object[]
    + +the profile type namings + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-profile-upload.api.mdx b/products/nerm/api/get-profile-upload.api.mdx new file mode 100644 index 000000000..fecde1065 --- /dev/null +++ b/products/nerm/api/get-profile-upload.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-profile-upload +sidebar_label: Retrieves the URL of an attachment attribute value from a profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProfileUpload","description":"Retrieves the URL of an attachment attribute value from a profile","tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"attribute_id","in":"path","description":"The id of the attachment attribute","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profiles/{id}/upload/{attribute_id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Retrieves the URL of an attachment attribute value from a profile","description":{"content":"Retrieves the URL of an attachment attribute value from a profile","type":"text/plain"},"url":{"path":["profiles",":id","upload",":attribute_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The id of the attachment attribute","type":"text/plain"},"type":"any","value":"","key":"attribute_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves the URL of an attachment attribute value from a profile' (get-profile-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves the URL of an attachment attribute value from a profile + + + +Retrieves the URL of an attachment attribute value from a profile + +
Path Parameters
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-profile.api.mdx b/products/nerm/api/get-profile.api.mdx new file mode 100644 index 000000000..533dbcc4a --- /dev/null +++ b/products/nerm/api/get-profile.api.mdx @@ -0,0 +1,43 @@ +--- +id: get-profile +sidebar_label: Find profile by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProfile","description":"Find profile by id","tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profiles/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find profile by id","description":{"content":"Find profile by id","type":"text/plain"},"url":{"path":["profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find profile by id' (get-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find profile by id + + + +Find profile by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-profiles.api.mdx b/products/nerm/api/get-profiles.api.mdx new file mode 100644 index 000000000..e3d8dbef3 --- /dev/null +++ b/products/nerm/api/get-profiles.api.mdx @@ -0,0 +1,43 @@ +--- +id: get-profiles +sidebar_label: Get profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProfiles","description":"Get profiles","tags":["Profiles"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"exclude_attributes","in":"query","description":"Allows for optimization by not returning the associated attribute data for the returned profiles","required":false,"schema":{"type":"boolean","default":false},"example":true},{"name":"name","in":"query","description":"object name for filtering","required":false,"schema":{"type":"string"},"example":"objectname"},{"name":"profile_type_id","in":"query","description":"Profile Type ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"status","in":"query","description":"status value for filtering","required":false,"schema":{"type":"string","enum":["Active","Inactive","On Leave","Terminated"]},"example":"Active"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profiles","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get profiles","description":{"content":"Get profiles","type":"text/plain"},"url":{"path":["profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for optimization by not returning the associated attribute data for the returned profiles","type":"text/plain"},"key":"exclude_attributes","value":""},{"disabled":false,"description":{"content":"object name for filtering","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Profile Type ID for filtering","type":"text/plain"},"key":"profile_type_id","value":""},{"disabled":false,"description":{"content":"status value for filtering","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get profiles' (get-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get profiles + + + +Get profiles + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-risk-level.api.mdx b/products/nerm/api/get-risk-level.api.mdx new file mode 100644 index 000000000..340df6b95 --- /dev/null +++ b/products/nerm/api/get-risk-level.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-risk-level +sidebar_label: Find risk level data by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRiskLevel","description":"Find risk level data by id","tags":["Risk Levels"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"risk_level":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"The label","type":"string","example":"my_risk_level"},"points":{"description":"The risk points","type":"number","format":"decimal","multipleOf":0.01,"example":0.5},"order":{"description":"The order of this risk level","type":"integer","format":"int32","minimum":0,"example":0}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/risk_levels/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find risk level data by id","description":{"content":"Find risk level data by id","type":"text/plain"},"url":{"path":["risk_levels",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find risk level data by id' (get-risk-level)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find risk level data by id + + + +Find risk level data by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    risk_level object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-risk-levels.api.mdx b/products/nerm/api/get-risk-levels.api.mdx new file mode 100644 index 000000000..27810b4b6 --- /dev/null +++ b/products/nerm/api/get-risk-levels.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-risk-levels +sidebar_label: Get risk level data in bulk +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRiskLevels","description":"This endpoint can retrieve risk level data in bulk from Lifecycle","tags":["Risk Levels"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"label","in":"query","description":"The attribute label to filter by","required":false,"example":"mylabel","schema":{"type":"string"}},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"risk_levels":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"The label","type":"string","example":"my_risk_level"},"points":{"description":"The risk points","type":"number","format":"decimal","multipleOf":0.01,"example":0.5},"order":{"description":"The order of this risk level","type":"integer","format":"int32","minimum":0,"example":0}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/risk_levels","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get risk level data in bulk","description":{"content":"This endpoint can retrieve risk level data in bulk from Lifecycle","type":"text/plain"},"url":{"path":["risk_levels"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The attribute label to filter by","type":"text/plain"},"key":"label","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get risk level data in bulk' (get-risk-levels)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get risk level data in bulk + + + +This endpoint can retrieve risk level data in bulk from Lifecycle + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    risk_levels object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-risk-score.api.mdx b/products/nerm/api/get-risk-score.api.mdx new file mode 100644 index 000000000..c3ccceca2 --- /dev/null +++ b/products/nerm/api/get-risk-score.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-risk-score +sidebar_label: Find risk score data by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRiskScore","description":"Find risk score data by id","tags":["Risk Scores"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"risk_score":{"type":"object","properties":{"id":{"description":"id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"object_id":{"description":"the object id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"object_type":{"description":"the object type","type":"string","enum":["Profile","WorkflowSession"],"example":"Profile"},"overall_score":{"description":"Overall score","type":"number","format":"decimal","multipleOf":0.01,"example":0.2},"overall_risk_level_id":{"description":"the overall risk level id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"impact_score":{"description":"the impact score","type":"number","format":"decimal","multipleOf":0.01,"example":0.4},"impact_risk_level_id":{"description":"the impact risk level id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"probability_score":{"description":"the probability_score","type":"number","format":"decimal","multipleOf":0.01,"example":0.5},"probability_risk_level_id":{"description":"The probability risk level id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/risk_scores/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find risk score data by id","description":{"content":"Find risk score data by id","type":"text/plain"},"url":{"path":["risk_scores",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find risk score data by id' (get-risk-score)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find risk score data by id + + + +Find risk score data by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    risk_score object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-risk-scores.api.mdx b/products/nerm/api/get-risk-scores.api.mdx new file mode 100644 index 000000000..c9002d9ac --- /dev/null +++ b/products/nerm/api/get-risk-scores.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-risk-scores +sidebar_label: Get risk score data in bulk +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRiskScores","description":"This endpoint can retrieve risk score data in bulk from Lifecycle","tags":["Risk Scores"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"object_id","in":"query","description":"ID of an object for filtering. Used along with object_type","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"object_type","in":"query","description":"Type of object that object_id represents","required":false,"schema":{"type":"string","enum":["Profile","WorkflowSession"]},"example":"Profile"},{"name":"overall_risk_level_id","in":"query","description":"Overall risk level to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":null},{"name":"impact_risk_level_id","in":"query","description":"Impact risk level to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"probability_risk_level_id","in":"query","description":"Probability risk level to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"risk_scores":{"type":"array","items":{"type":"object","properties":{"id":{"description":"id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"object_id":{"description":"the object id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"object_type":{"description":"the object type","type":"string","enum":["Profile","WorkflowSession"],"example":"Profile"},"overall_score":{"description":"Overall score","type":"number","format":"decimal","multipleOf":0.01,"example":0.2},"overall_risk_level_id":{"description":"the overall risk level id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"impact_score":{"description":"the impact score","type":"number","format":"decimal","multipleOf":0.01,"example":0.4},"impact_risk_level_id":{"description":"the impact risk level id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"probability_score":{"description":"the probability_score","type":"number","format":"decimal","multipleOf":0.01,"example":0.5},"probability_risk_level_id":{"description":"The probability risk level id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/risk_scores","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get risk score data in bulk","description":{"content":"This endpoint can retrieve risk score data in bulk from Lifecycle","type":"text/plain"},"url":{"path":["risk_scores"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of an object for filtering. Used along with object_type","type":"text/plain"},"key":"object_id","value":""},{"disabled":false,"description":{"content":"Type of object that object_id represents","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"Overall risk level to filter by","type":"text/plain"},"key":"overall_risk_level_id","value":""},{"disabled":false,"description":{"content":"Impact risk level to filter by","type":"text/plain"},"key":"impact_risk_level_id","value":""},{"disabled":false,"description":{"content":"Probability risk level to filter by","type":"text/plain"},"key":"probability_risk_level_id","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get risk score data in bulk' (get-risk-scores)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get risk score data in bulk + + + +This endpoint can retrieve risk score data in bulk from Lifecycle + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    risk_scores object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-role-profile.api.mdx b/products/nerm/api/get-role-profile.api.mdx new file mode 100644 index 000000000..7b7f474d6 --- /dev/null +++ b/products/nerm/api/get-role-profile.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-role-profile +sidebar_label: Find role-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleProfile","description":"Find role-profile contributor relationship by id","tags":["Role Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role_profile":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/role_profiles/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find role-profile contributor relationship by id","description":{"content":"Find role-profile contributor relationship by id","type":"text/plain"},"url":{"path":["role_profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find role-profile contributor relationship by id' (get-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find role-profile contributor relationship by id + + + +Find role-profile contributor relationship by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    role_profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-role-profiles.api.mdx b/products/nerm/api/get-role-profiles.api.mdx new file mode 100644 index 000000000..f5de24c0b --- /dev/null +++ b/products/nerm/api/get-role-profiles.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-role-profiles +sidebar_label: Get role-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleProfiles","description":"Get role-profile contributor relationships","tags":["Role Profiles"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"role_id","in":"query","description":"The ID of a role for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/role_profiles","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get role-profile contributor relationships","description":{"content":"Get role-profile contributor relationships","type":"text/plain"},"url":{"path":["role_profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of a role for filtering","type":"text/plain"},"key":"role_id","value":""},{"disabled":false,"description":{"content":"Profile ID to filter by","type":"text/plain"},"key":"profile_id","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get role-profile contributor relationships' (get-role-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get role-profile contributor relationships + + + +Get role-profile contributor relationships + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    role_profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-role.api.mdx b/products/nerm/api/get-role.api.mdx new file mode 100644 index 000000000..d764d57f9 --- /dev/null +++ b/products/nerm/api/get-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-role +sidebar_label: Find role by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRole","description":"Info for a specific user role","tags":["Roles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/roles/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find role by id","description":{"content":"Info for a specific user role","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find role by id' (get-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find role by id + + + +Info for a specific user role + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-roles.api.mdx b/products/nerm/api/get-roles.api.mdx new file mode 100644 index 000000000..605d3267d --- /dev/null +++ b/products/nerm/api/get-roles.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-roles +sidebar_label: Get roles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoles","description":"This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.","tags":["Roles"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/roles","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get roles","description":{"content":"This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get roles' (get-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get roles + + + +This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    roles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-avatar.api.mdx b/products/nerm/api/get-user-avatar.api.mdx new file mode 100644 index 000000000..09b938c93 --- /dev/null +++ b/products/nerm/api/get-user-avatar.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-avatar +sidebar_label: Retrieves the URL of the user avatar +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserAvatar","description":"Retrieves the URL of the user avatar","tags":["Users"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/users/{id}/avatar","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Retrieves the URL of the user avatar","description":{"content":"Retrieves the URL of the user avatar","type":"text/plain"},"url":{"path":["users",":id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves the URL of the user avatar' (get-user-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves the URL of the user avatar + + + +Retrieves the URL of the user avatar + +
Path Parameters
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-manager.api.mdx b/products/nerm/api/get-user-manager.api.mdx new file mode 100644 index 000000000..5e754d25e --- /dev/null +++ b/products/nerm/api/get-user-manager.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-manager +sidebar_label: Find user-manager relationship by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserManager","description":"Info for a specific user-manager relationship","tags":["User Managers"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_manager":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/user_managers/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find user-manager relationship by id","description":{"content":"Info for a specific user-manager relationship","type":"text/plain"},"url":{"path":["user_managers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user-manager relationship by id' (get-user-manager)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find user-manager relationship by id + + + +Info for a specific user-manager relationship + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    user_manager object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-managers.api.mdx b/products/nerm/api/get-user-managers.api.mdx new file mode 100644 index 000000000..ffcec7328 --- /dev/null +++ b/products/nerm/api/get-user-managers.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-managers +sidebar_label: Get user-manager relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserManagers","description":"This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters","tags":["User Managers"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"user_id","in":"query","description":"The ID of a user for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"manager_id","in":"query","description":"The ID of a user for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_managers":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/user_managers","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get user-manager relationships","description":{"content":"This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters","type":"text/plain"},"url":{"path":["user_managers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of a user for filtering","type":"text/plain"},"key":"user_id","value":""},{"disabled":false,"description":{"content":"The ID of a user for filtering","type":"text/plain"},"key":"manager_id","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get user-manager relationships' (get-user-managers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get user-manager relationships + + + +This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    user_managers object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-profile.api.mdx b/products/nerm/api/get-user-profile.api.mdx new file mode 100644 index 000000000..f30e8516d --- /dev/null +++ b/products/nerm/api/get-user-profile.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-profile +sidebar_label: Find user-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserProfile","description":"Find user-profile contributor relationship by id","tags":["User Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_profile":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/user_profiles/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find user-profile contributor relationship by id","description":{"content":"Find user-profile contributor relationship by id","type":"text/plain"},"url":{"path":["user_profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user-profile contributor relationship by id' (get-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find user-profile contributor relationship by id + + + +Find user-profile contributor relationship by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    user_profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-profiles.api.mdx b/products/nerm/api/get-user-profiles.api.mdx new file mode 100644 index 000000000..051e7ad80 --- /dev/null +++ b/products/nerm/api/get-user-profiles.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-profiles +sidebar_label: Get user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserProfiles","description":"Get user-profile contributor relationships","tags":["User Profiles"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"user_id","in":"query","description":"The ID of a user for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"ne_attribute_id","in":"query","description":"ID of an attribute for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"relationship_type","in":"query","description":"Type of user contributor relationship to filter by","required":false,"schema":{"type":"string","enum":["owner","contributor"]},"example":"owner"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/user_profiles","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get user-profile contributor relationships","description":{"content":"Get user-profile contributor relationships","type":"text/plain"},"url":{"path":["user_profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of a user for filtering","type":"text/plain"},"key":"user_id","value":""},{"disabled":false,"description":{"content":"ID of an attribute for filtering","type":"text/plain"},"key":"ne_attribute_id","value":""},{"disabled":false,"description":{"content":"Profile ID to filter by","type":"text/plain"},"key":"profile_id","value":""},{"disabled":false,"description":{"content":"Type of user contributor relationship to filter by","type":"text/plain"},"key":"relationship_type","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get user-profile contributor relationships' (get-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get user-profile contributor relationships + + + +Get user-profile contributor relationships + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    user_profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-role.api.mdx b/products/nerm/api/get-user-role.api.mdx new file mode 100644 index 000000000..5189f4f3c --- /dev/null +++ b/products/nerm/api/get-user-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-role +sidebar_label: Find user role pairing by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserRole","description":"Info for a specific user role pairing","tags":["User Roles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/user_roles/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find user role pairing by id","description":{"content":"Info for a specific user role pairing","type":"text/plain"},"url":{"path":["user_roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user role pairing by id' (get-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find user role pairing by id + + + +Info for a specific user role pairing + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user-roles.api.mdx b/products/nerm/api/get-user-roles.api.mdx new file mode 100644 index 000000000..d341488b8 --- /dev/null +++ b/products/nerm/api/get-user-roles.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user-roles +sidebar_label: Get user role pairings +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserRoles","description":"This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters","tags":["User Roles"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"user_id","in":"query","description":"The ID of a user for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"role_id","in":"query","description":"The ID of a role for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_roles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/user_roles","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get user role pairings","description":{"content":"This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters","type":"text/plain"},"url":{"path":["user_roles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of a user for filtering","type":"text/plain"},"key":"user_id","value":""},{"disabled":false,"description":{"content":"The ID of a role for filtering","type":"text/plain"},"key":"role_id","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get user role pairings' (get-user-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get user role pairings + + + +This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    user_roles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-user.api.mdx b/products/nerm/api/get-user.api.mdx new file mode 100644 index 000000000..108677ebf --- /dev/null +++ b/products/nerm/api/get-user.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-user +sidebar_label: Find user by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUser","description":"Info for a specific user","tags":["Users"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/users/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find user by id","description":{"content":"Info for a specific user","type":"text/plain"},"url":{"path":["users",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user by id' (get-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find user by id + + + +Info for a specific user + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    user object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-users.api.mdx b/products/nerm/api/get-users.api.mdx new file mode 100644 index 000000000..964392d81 --- /dev/null +++ b/products/nerm/api/get-users.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-users +sidebar_label: Get users +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUsers","description":"This endpoint can retrieve users from Lifecycle or you can search for users using parameters","tags":["Users"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"name","in":"query","description":"object name for filtering","required":false,"schema":{"type":"string"},"example":"objectname"},{"name":"login","in":"query","description":"The user login to search by","required":false,"schema":{"type":"string"},"example":"myuser"},{"name":"title","in":"query","description":"The user title to search by","required":false,"schema":{"type":"string"},"example":"usertitle"},{"name":"status","in":"query","description":"status value for filtering","required":false,"schema":{"type":"string","enum":["Active","Inactive","On Leave","Terminated"]},"example":"Active"},{"name":"email","in":"query","description":"The user email to search by","required":false,"schema":{"type":"string","format":"email"},"example":"test@sailpoint.com"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/users","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get users","description":{"content":"This endpoint can retrieve users from Lifecycle or you can search for users using parameters","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"object name for filtering","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"The user login to search by","type":"text/plain"},"key":"login","value":""},{"disabled":false,"description":{"content":"The user title to search by","type":"text/plain"},"key":"title","value":""},{"disabled":false,"description":{"content":"status value for filtering","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The user email to search by","type":"text/plain"},"key":"email","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get users' (get-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get users + + + +This endpoint can retrieve users from Lifecycle or you can search for users using parameters + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    users object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-workflow-session-upload.api.mdx b/products/nerm/api/get-workflow-session-upload.api.mdx new file mode 100644 index 000000000..6a07d87f0 --- /dev/null +++ b/products/nerm/api/get-workflow-session-upload.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-workflow-session-upload +sidebar_label: Retrieves the URL of an attachment attribute value from a workflow session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflowSessionUpload","description":"Retrieves the URL of an attachment attribute value from a workflow session","tags":["Workflow Sessions"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"attribute_id","in":"path","description":"The id of the attachment attribute","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/workflow_sessions/{id}/upload/{attribute_id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Retrieves the URL of an attachment attribute value from a workflow session","description":{"content":"Retrieves the URL of an attachment attribute value from a workflow session","type":"text/plain"},"url":{"path":["workflow_sessions",":id","upload",":attribute_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The id of the attachment attribute","type":"text/plain"},"type":"any","value":"","key":"attribute_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves the URL of an attachment attribute value from a workflow session' (get-workflow-session-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves the URL of an attachment attribute value from a workflow session + + + +Retrieves the URL of an attachment attribute value from a workflow session + +
Path Parameters
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-workflow-session.api.mdx b/products/nerm/api/get-workflow-session.api.mdx new file mode 100644 index 000000000..808340aee --- /dev/null +++ b/products/nerm/api/get-workflow-session.api.mdx @@ -0,0 +1,43 @@ +--- +id: get-workflow-session +sidebar_label: Find workflow session by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflowSession","description":"Find workflow session by id","tags":["Workflow Sessions"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"workflow_id":{"description":"The workflow id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"the requester id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"The requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t"]},"status":{"description":"The status","type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/workflow_sessions/{id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Find workflow session by id","description":{"content":"Find workflow session by id","type":"text/plain"},"url":{"path":["workflow_sessions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find workflow session by id' (get-workflow-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Find workflow session by id + + + +Find workflow session by id + +
Path Parameters
+ +Expected response to a valid request + +
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +The attributes + +
  • property name* string
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/get-workflow-sessions.api.mdx b/products/nerm/api/get-workflow-sessions.api.mdx new file mode 100644 index 000000000..6c6754ccf --- /dev/null +++ b/products/nerm/api/get-workflow-sessions.api.mdx @@ -0,0 +1,43 @@ +--- +id: get-workflow-sessions +sidebar_label: Get workflow sessions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflowSessions","description":"Get workflow sessions","tags":["Workflow Sessions"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"uid","in":"query","description":"Workflow session uid for filtering","required":false,"schema":{"type":"string","minLength":32,"maxLength":32},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"workflow_id","in":"query","description":"Workflow ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"requester_id","in":"query","description":"Requester ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"status","in":"query","description":"filter by workflow session status","required":false,"schema":{"type":"string","enum":["waiting on workflow","identity proofing completed","new","closing","pending request","requested","pending approval","approved","pending notification","notified","pending review","reviewed","pending trigger","stored procedure","pending status change","status changed","pending update","non employee updated","non employee created","pending creation","rejected","pending assignment","assigned","default","failed","un assigned","auto assigned","ldap provided","pending ldap","pending fulfillment","pending stored procedure","pending courion add","fulfilled","pending courion update","courion add","pending courion_extend","courion update","pending courion terminate","courion extend","pending profile select","courion terminate","batch completed","profiles selected","answered questions","pending questions","attempting to start workflow","started workflow","profile check complete","completed","processing","pending set attribute","invitation sent","action skipped","api request sent","attribute set","disabled","duplicates resolved","soap request sent","checking for duplicates","pending identity proofing","closed","workflow changed"]},"example":"batch completed"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_sessions":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"workflow_id":{"description":"The workflow id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"the requester id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"The requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t"]},"status":{"description":"The status","type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}},"_metadata":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/workflow_sessions","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get workflow sessions","description":{"content":"Get workflow sessions","type":"text/plain"},"url":{"path":["workflow_sessions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Profile ID to filter by","type":"text/plain"},"key":"profile_id","value":""},{"disabled":false,"description":{"content":"Workflow session uid for filtering","type":"text/plain"},"key":"uid","value":""},{"disabled":false,"description":{"content":"Workflow ID for filtering","type":"text/plain"},"key":"workflow_id","value":""},{"disabled":false,"description":{"content":"Requester ID for filtering","type":"text/plain"},"key":"requester_id","value":""},{"disabled":false,"description":{"content":"filter by workflow session status","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get workflow sessions' (get-workflow-sessions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get workflow sessions + + + +Get workflow sessions + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    workflow_sessions object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +The attributes + +
  • property name* string
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/nerm-lifecycle-api.info.mdx b/products/nerm/api/nerm-lifecycle-api.info.mdx new file mode 100644 index 000000000..6b2d61e66 --- /dev/null +++ b/products/nerm/api/nerm-lifecycle-api.info.mdx @@ -0,0 +1,22 @@ +--- +id: nerm-lifecycle-api +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'NERM Lifecycle API' (nerm-lifecycle-api)" +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 1.0.0 + +# NERM Lifecycle API + + + +The Lifecycle API can be used to access and modify various resources in your environment. + +

License

\ No newline at end of file diff --git a/products/nerm/api/patch-advanced-search.api.mdx b/products/nerm/api/patch-advanced-search.api.mdx new file mode 100644 index 000000000..3fc2ca2f5 --- /dev/null +++ b/products/nerm/api/patch-advanced-search.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-advanced-search +sidebar_label: Update a saved advanced search query +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchAdvancedSearch","description":"Update a saved advanced search query","tags":["Advanced Search"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"advanced_search":{"type":"object","properties":{"id":{"description":"the id of the object","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"the label","type":"string","example":"mylabel"},"condition_rules_attributes":{"description":"The attributes for the condition rules","type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"the type","type":"string","required":true,"enum":["ProfileTypeRule"],"example":"ProfileTypeRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value to use in the comparison","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"_destroy":{"description":"Should this Profile type rule be destroyed?","type":"boolean","default":false,"example":false}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileStatusRule"],"example":"ProfileStatusRule"},"comparison_operator":{"description":"The operator to use to compare","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","enum":["Active","Inactive","Leave of absence","Terminated"],"example":"Active"},"_destroy":{"description":"Should this be destroyed","type":"boolean","default":false,"example":false}}},{"type":"object","properties":{"id":{"description":"The Id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"],"example":"TextAreaAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator used for comparisons","type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"],"example":"=="},"value":{"description":"The value","type":"string","required":true,"example":"Some value"},"_destroy":{"description":"Destroy","type":"boolean","default":false,"example":false}}},{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"the type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["DateAttribute"],"example":"DateAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_attribute_type":{"description":"the secondary attribute type","type":"string","enum":["DateAttribute"],"example":"DateAttribute"},"secondary_attribute_id":{"description":"The secondary attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":[">","<","after","before"],"example":"<"},"value":{"description":"The value","type":"string","required":true,"enum":["Today",""],"example":"Today"},"secondary_value":{"description":"The secondary value","type":"string","enum":["after","before"],"example":"after"},"tertiary_value":{"description":"The tertiary value","type":"string","example":30},"_destroy":{"description":"should this be destroyed","type":"boolean","default":false,"example":false}}},{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the iud","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"the type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition object type","type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"],"example":"ProfileSearchAttribute"},"condition_object_id":{"description":"The condition object id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["include?","exclude?"],"example":"include?"},"value":{"description":"the value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"_destroy":{"description":"Should this be destroyed?","type":"boolean","default":false,"example":false}}},{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"the type","type":"string","required":true,"enum":["RiskRule"],"example":"RiskRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==",">","<"],"example":"=="},"value":{"description":"the value","type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_value":{"description":"The secondary value","type":"string","required":true,"enum":["OverallRisk"],"example":"OverallRisk"},"_destroy":{"description":"Should this riskrule be destroyed","type":"boolean","default":false,"example":false}}}]},"example":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"type":"ProfileStatusRule","id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","comparison_operator":"==","value":"Active"}]}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"advanced_search":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"the label","type":"string","example":"mylabel"},"condition_rules_attributes":{"description":"The condition rules attributes","type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uuid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileTypeRule"],"example":"ProfileTypeRule"},"comparison_operator":{"description":"The comparison operator","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileStatusRule"],"example":"ProfileStatusRule"},"comparison_operator":{"description":"The comparison operator","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","enum":["Active","Inactive","Leave of absence","Terminated"],"example":"Active"}}},{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"],"example":"TextAreaAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"],"example":"=="},"value":{"description":"The value","type":"string","required":true,"example":"Some value"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition object type","type":"string","required":true,"enum":["DateAttribute"],"example":"DateAttribute"},"condition_object_id":{"description":"The condition object id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_attribute_type":{"description":"The secondary_attribute_type","type":"string","enum":["DateAttribute"],"example":"DateAttribute"},"secondary_attribute_id":{"description":"The secondary_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":[">","<","after","before"],"example":"<"},"value":{"description":"The value to use for comparison","type":"string","required":true,"enum":["Today",""],"example":"Today"},"secondary_value":{"description":"The secondary value","type":"string","enum":["after","before"],"example":"after"},"tertiary_value":{"description":"the tertiary_value","type":"string","example":30}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"],"example":"OwnerSearchAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The comparison_operator","type":"string","required":true,"enum":["include?","exclude?"],"example":"include?"},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["RiskRule"],"example":"RiskRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==",">","<"],"example":"=="},"value":{"description":"Id of the Risk Level being compared against","type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_value":{"description":"The secondary value","type":"string","required":true,"enum":["OverallRisk"],"example":"OverallRisk"}}}]},"example":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"type":"ProfileStatusRule","id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","comparison_operator":"==","value":"Active"}]}}}}}}}}},"method":"patch","path":"/advanced_search/{id}","jsonRequestBodyExample":{"advanced_search":{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","label":"mylabel","condition_rules_attributes":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"type":"ProfileStatusRule","id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","comparison_operator":"==","value":"Active"}]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a saved advanced search query","description":{"content":"Update a saved advanced search query","type":"text/plain"},"url":{"path":["advanced_search",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a saved advanced search query' (patch-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a saved advanced search query + + + +Update a saved advanced search query + +
Path Parameters
Request Body required
    advanced_search object
    condition_rules_attributes object[]
    + +The attributes for the condition rules + +
    anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} defaultValue={undefined}>`, `<`, `after`, `before`]"} defaultValue={undefined}>`]"} defaultValue={undefined}>`, `<`]"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    advanced_search object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    condition_rules_attributes object[]
    + +The condition rules attributes + +
    anyOf= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`, `start_with?`, `end_with?`, `include?`]"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`, `after`, `before`]"} defaultValue={undefined}>`]"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`]"} defaultValue={undefined}>
\ No newline at end of file diff --git a/products/nerm/api/patch-attribute-option.api.mdx b/products/nerm/api/patch-attribute-option.api.mdx new file mode 100644 index 000000000..1cd98a86b --- /dev/null +++ b/products/nerm/api/patch-attribute-option.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-attribute-option +sidebar_label: Update a option based attribute value by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchAttributeOption","description":"Update a option based attribute value by id","tags":["Attribute Options"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_option":{"type":"object","properties":{"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"The option","type":"string","example":"optionname"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_option":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"the option","type":"string","example":"myoption"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/ne_attribute_options/{id}","jsonRequestBodyExample":{"ne_attribute_option":{"ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","option":"optionname"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a option based attribute value by id","description":{"content":"Update a option based attribute value by id","type":"text/plain"},"url":{"path":["ne_attribute_options",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a option based attribute value by id' (patch-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a option based attribute value by id + + + +Update a option based attribute value by id + +
Path Parameters
Request Body required
    ne_attribute_option object
+ +Expected response to a valid request + +
Schema
    ne_attribute_option object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-attribute-options.api.mdx b/products/nerm/api/patch-attribute-options.api.mdx new file mode 100644 index 000000000..5ad4edba6 --- /dev/null +++ b/products/nerm/api/patch-attribute-options.api.mdx @@ -0,0 +1,43 @@ +--- +id: patch-attribute-options +sidebar_label: Update multiple option based attribute values +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchAttributeOptions","description":"Update multiple option based attribute values","tags":["Attribute Options"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_options":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The ID","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"The option","type":"string","example":"option"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"ne_attribute_options":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"the option","type":"string","example":"myoption"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","option":"myoption1"},{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9d511","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9d511","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9d511","option":"myoption2"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/ne_attribute_options","jsonRequestBodyExample":{"ne_attribute_options":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","option":"option"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple option based attribute values","description":{"content":"Update multiple option based attribute values","type":"text/plain"},"url":{"path":["ne_attribute_options"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple option based attribute values' (patch-attribute-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple option based attribute values + + + +Update multiple option based attribute values + +
Request Body required
    ne_attribute_options object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    ne_attribute_options object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-profile-type.api.mdx b/products/nerm/api/patch-profile-type.api.mdx new file mode 100644 index 000000000..187f7f554 --- /dev/null +++ b/products/nerm/api/patch-profile-type.api.mdx @@ -0,0 +1,55 @@ +--- +id: patch-profile-type +sidebar_label: Update a profile type by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchProfileType","description":"Update a profile type by id","tags":["Profile Types"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile_type":{"type":"object","properties":{"name":{"description":"The name","type":"string","example":"my_profile_type_name"},"bypass_dup_protection":{"description":"Bypass duplicate protection","type":"boolean","example":false},"archived":{"description":"Is the profile type archived","type":"boolean","example":false},"permitted_role_ids":{"description":"Permitted role ids","type":"array","items":{"type":"string","format":"uuid"},"example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b"]},"profile_type_dup_attributes":{"description":"Profile type duplicate attributes","type":"array","items":{"type":"object","properties":{"id":{"description":"The ID","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},"profile_type_namings":{"description":"Profile type namings","type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"order":{"description":"The order the profile type appears","type":"integer","minimum":0,"example":0}}}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile_type":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile type"},"bypass_dup_protection":{"description":"bypass duplicate protection?","type":"boolean","example":false},"archived":{"description":"is this profile type archived?","type":"boolean","example":false},"permitted_role_ids":{"description":"permitted role_ids for this profile_type","type":"array","items":{"type":"string","format":"uuid"},"example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df92"]},"profile_type_dup_attributes":{"description":"The profile type duplicate attributes","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h"}]},"profile_type_namings":{"description":"the profile type namings","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"order":{"description":"the order","type":"integer","format":"int32","minimum":0,"example":0}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h","order":0}]}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/profile_types/{id}","jsonRequestBodyExample":{"profile_type":{"name":"my_profile_type_name","bypass_dup_protection":false,"archived":false,"permitted_role_ids":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b"],"profile_type_dup_attributes":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"profile_type_namings":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","order":0}]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a profile type by id","description":{"content":"Update a profile type by id","type":"text/plain"},"url":{"path":["profile_types",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a profile type by id' (patch-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a profile type by id + + + +Update a profile type by id + +
Path Parameters
Request Body required
    profile_type object
    profile_type_dup_attributes object[]
    + +Profile type duplicate attributes + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_namings object[]
    + +Profile type namings + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    profile_type object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_dup_attributes object[]
    + +The profile type duplicate attributes + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_namings object[]
    + +the profile type namings + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-profile.api.mdx b/products/nerm/api/patch-profile.api.mdx new file mode 100644 index 000000000..d10a20717 --- /dev/null +++ b/products/nerm/api/patch-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-profile +sidebar_label: Update a profile by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchProfile","description":"Update a profile by id","tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"name":{"description":"the name","type":"string","example":"testprofile"},"profile_type_id":{"description":"The profile_type_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"The Status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"The id_proofing_status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"archived":{"description":"Return archived items","type":"boolean","default":false,"example":false},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/profiles/{id}","jsonRequestBodyExample":{"profile":{"name":"testprofile","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","archived":false,"attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a profile by id","description":{"content":"Update a profile by id","type":"text/plain"},"url":{"path":["profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a profile by id' (patch-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a profile by id + + + +Update a profile by id + +
Path Parameters
Request Body required
    profile object
    attributes object
    + +The attributes + +
  • property name* string
+ +Expected response to a valid request + +
Schema
    profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-profiles.api.mdx b/products/nerm/api/patch-profiles.api.mdx new file mode 100644 index 000000000..c36f24642 --- /dev/null +++ b/products/nerm/api/patch-profiles.api.mdx @@ -0,0 +1,51 @@ +--- +id: patch-profiles +sidebar_label: Update multiple profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchProfiles","description":"Update multiple profiles","tags":["Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"profile name here"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"The id proofing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"archived":{"description":"should profile be archived?","type":"boolean","default":false,"example":false},"attributes":{"description":"The attrbutes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"my profile","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","created_at":"2023-05-01T09:12:28Z","updated_at":"2023-05-01T09:12:28Z","attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/profiles","jsonRequestBodyExample":{"profiles":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"profile name here","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","archived":false,"attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple profiles","description":{"content":"Update multiple profiles","type":"text/plain"},"url":{"path":["profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple profiles' (patch-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple profiles + + + +Update multiple profiles + +
Request Body required
    profiles object[]
    attributes object
    + +The attrbutes + +
  • property name* string
+ +Expected response to a valid request + +
Schema
    oneOf
    profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
    • job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-role-profile.api.mdx b/products/nerm/api/patch-role-profile.api.mdx new file mode 100644 index 000000000..4fd412e33 --- /dev/null +++ b/products/nerm/api/patch-role-profile.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-role-profile +sidebar_label: Update a role-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRoleProfile","description":"Update a role-profile contributor relationship by id","tags":["Role Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role_profile":{"type":"object","properties":{"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"the profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role_profile":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/role_profiles/{id}","jsonRequestBodyExample":{"role_profile":{"role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a role-profile contributor relationship by id","description":{"content":"Update a role-profile contributor relationship by id","type":"text/plain"},"url":{"path":["role_profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a role-profile contributor relationship by id' (patch-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a role-profile contributor relationship by id + + + +Update a role-profile contributor relationship by id + +
Path Parameters
Request Body required
    role_profile object
+ +Expected response to a valid request + +
Schema
    role_profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-role-profiles.api.mdx b/products/nerm/api/patch-role-profiles.api.mdx new file mode 100644 index 000000000..d7ffc9f51 --- /dev/null +++ b/products/nerm/api/patch-role-profiles.api.mdx @@ -0,0 +1,43 @@ +--- +id: patch-role-profiles +sidebar_label: Update multiple role-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRoleProfiles","description":"Update multiple role-profile contributor relationships","tags":["Role Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"the profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"role_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/role_profiles","jsonRequestBodyExample":{"role_profiles":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple role-profile contributor relationships","description":{"content":"Update multiple role-profile contributor relationships","type":"text/plain"},"url":{"path":["role_profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple role-profile contributor relationships' (patch-role-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple role-profile contributor relationships + + + +Update multiple role-profile contributor relationships + +
Request Body required
    role_profiles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    role_profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-role.api.mdx b/products/nerm/api/patch-role.api.mdx new file mode 100644 index 000000000..df538de18 --- /dev/null +++ b/products/nerm/api/patch-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-role +sidebar_label: Update an existing role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRole","description":"Update an existing role","tags":["Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"type":{"description":"The type","type":"string","enum":["NeprofileRole","NeaccessRole"],"example":"NeprofileRole"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}}}}}}},"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/roles/{id}","jsonRequestBodyExample":{"role":{"type":"NeprofileRole","name":"Sponsors","groups":["ad_group_name"]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update an existing role","description":{"content":"Update an existing role","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update an existing role' (patch-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update an existing role + + + +Update an existing role + +
Path Parameters
Request Body required
    role object
+ +Expected response to a valid request + +
Schema
    role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-roles.api.mdx b/products/nerm/api/patch-roles.api.mdx new file mode 100644 index 000000000..f37995191 --- /dev/null +++ b/products/nerm/api/patch-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-roles +sidebar_label: Update multiple roles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRoles","description":"Update multiple users","tags":["Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type","type":"string","enum":["NeprofileRole","NeaccessRole"],"example":"NeprofileRole"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"roles":{"description":"the list of roles","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"sponsors_role","name":"Sponsors","groups":["ad_group_name"]}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/roles","jsonRequestBodyExample":{"roles":[{"type":"NeprofileRole","name":"Sponsors","groups":["ad_group_name"]}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple roles","description":{"content":"Update multiple users","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple roles' (patch-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple roles + + + +Update multiple users + +
Request Body required
    roles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    roles object[]
    + +the list of roles + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user-manager.api.mdx b/products/nerm/api/patch-user-manager.api.mdx new file mode 100644 index 000000000..801ada348 --- /dev/null +++ b/products/nerm/api/patch-user-manager.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-user-manager +sidebar_label: Update a user-manager relationship by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUserManager","description":"Update a user-manager relationship by id","tags":["User Managers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_manager":{"type":"object","properties":{"user_id":{"description":"The user_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"The manager_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_manager":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_managers/{id}","jsonRequestBodyExample":{"user_manager":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","manager_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a user-manager relationship by id","description":{"content":"Update a user-manager relationship by id","type":"text/plain"},"url":{"path":["user_managers",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a user-manager relationship by id' (patch-user-manager)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a user-manager relationship by id + + + +Update a user-manager relationship by id + +
Path Parameters
Request Body required
    user_manager object
+ +Expected response to a valid request + +
Schema
    user_manager object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user-managers.api.mdx b/products/nerm/api/patch-user-managers.api.mdx new file mode 100644 index 000000000..d6bd468dc --- /dev/null +++ b/products/nerm/api/patch-user-managers.api.mdx @@ -0,0 +1,43 @@ +--- +id: patch-user-managers +sidebar_label: Update multiple user-manager relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUserManagers","description":"Update multiple user-manager relationships","tags":["User Managers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_managers":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"The manager_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}},{"type":"object","properties":{"user_managers":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h","manager_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9l"}]}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_managers","jsonRequestBodyExample":{"user_managers":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","manager_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple user-manager relationships","description":{"content":"Update multiple user-manager relationships","type":"text/plain"},"url":{"path":["user_managers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple user-manager relationships' (patch-user-managers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple user-manager relationships + + + +Update multiple user-manager relationships + +
Request Body required
    user_managers object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    job_status object
    + +the status of the job + +
    user_managers object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user-profile.api.mdx b/products/nerm/api/patch-user-profile.api.mdx new file mode 100644 index 000000000..c7b961243 --- /dev/null +++ b/products/nerm/api/patch-user-profile.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-user-profile +sidebar_label: Update a user-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUserProfile","description":"Update a user-profile contributor relationship by id","tags":["User Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_profile":{"type":"object","properties":{"user_id":{"description":"The user_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"The relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_profile":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_profiles/{id}","jsonRequestBodyExample":{"user_profile":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","relationship_type":"owner"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a user-profile contributor relationship by id","description":{"content":"Update a user-profile contributor relationship by id","type":"text/plain"},"url":{"path":["user_profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a user-profile contributor relationship by id' (patch-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a user-profile contributor relationship by id + + + +Update a user-profile contributor relationship by id + +
Path Parameters
Request Body required
    user_profile object
+ +Expected response to a valid request + +
Schema
    user_profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user-profiles.api.mdx b/products/nerm/api/patch-user-profiles.api.mdx new file mode 100644 index 000000000..c44c74e8f --- /dev/null +++ b/products/nerm/api/patch-user-profiles.api.mdx @@ -0,0 +1,43 @@ +--- +id: patch-user-profiles +sidebar_label: Update multiple user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUserProfiles","description":"Update multiple user-profile contributor relationships","tags":["User Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"the profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"user_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","relationship_type":"owner"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_profiles","jsonRequestBodyExample":{"user_profiles":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","relationship_type":"owner"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple user-profile contributor relationships","description":{"content":"Update multiple user-profile contributor relationships","type":"text/plain"},"url":{"path":["user_profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple user-profile contributor relationships' (patch-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple user-profile contributor relationships + + + +Update multiple user-profile contributor relationships + +
Request Body required
    user_profiles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user-role.api.mdx b/products/nerm/api/patch-user-role.api.mdx new file mode 100644 index 000000000..526813682 --- /dev/null +++ b/products/nerm/api/patch-user-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-user-role +sidebar_label: Update a user role pairing by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUserRole","description":"Update a user role pairing by id","tags":["User Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"user_id":{"description":"The user_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_roles/{id}","jsonRequestBodyExample":{"user_role":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a user role pairing by id","description":{"content":"Update a user role pairing by id","type":"text/plain"},"url":{"path":["user_roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a user role pairing by id' (patch-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a user role pairing by id + + + +Update a user role pairing by id + +
Path Parameters
Request Body required
    user_role object
+ +Expected response to a valid request + +
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user-roles.api.mdx b/products/nerm/api/patch-user-roles.api.mdx new file mode 100644 index 000000000..5d6ec5852 --- /dev/null +++ b/products/nerm/api/patch-user-roles.api.mdx @@ -0,0 +1,43 @@ +--- +id: patch-user-roles +sidebar_label: Update multiple user role pairings +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUserRoles","description":"Update multiple user role pairings","tags":["User Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_roles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The uuid","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"user_roles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9a","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9c","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_roles","jsonRequestBodyExample":{"user_roles":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple user role pairings","description":{"content":"Update multiple user role pairings","type":"text/plain"},"url":{"path":["user_roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple user role pairings' (patch-user-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple user role pairings + + + +Update multiple user role pairings + +
Request Body required
    user_roles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_roles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-user.api.mdx b/products/nerm/api/patch-user.api.mdx new file mode 100644 index 000000000..2961b3cff --- /dev/null +++ b/products/nerm/api/patch-user.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-user +sidebar_label: Update a user by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUser","description":"Update a user by id","tags":["Users"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","required":true,"writeOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"myusername"},"email":{"description":"The email","type":"string","format":"email","example":"test@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"mylogin"},"admin":{"description":"Is the user an admin","type":"boolean","example":false},"group_strings":{"description":"The group strings (used in roles later on)","type":"string","example":"Administrator_group,Developer_group"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/users/{id}","jsonRequestBodyExample":{"user":{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"myusername","email":"test@sailpoint.com","type":"NeprofileUser","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","title":"mytitle","status":"Active","login":"mylogin","admin":false,"group_strings":"Administrator_group,Developer_group"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a user by id","description":{"content":"Update a user by id","type":"text/plain"},"url":{"path":["users",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a user by id' (patch-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a user by id + + + +Update a user by id + +
Path Parameters
Request Body required
    user object
+ +Expected response to a valid request + +
Schema
    user object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-users.api.mdx b/products/nerm/api/patch-users.api.mdx new file mode 100644 index 000000000..6d4d956b3 --- /dev/null +++ b/products/nerm/api/patch-users.api.mdx @@ -0,0 +1,43 @@ +--- +id: patch-users +sidebar_label: Update multiple users +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchUsers","description":"Update multiple users","tags":["Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","required":true,"writeOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"myusername"},"email":{"description":"The email","type":"string","format":"email","example":"test@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"mylogin"},"admin":{"description":"Is the user an admin","type":"boolean","example":false},"group_strings":{"description":"The group strings (used in roles later on)","type":"string","example":"Administrator_group,Developer_group"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"bob","email":"example@sailpoint.com","type":"NeprofileUser","title":"mytitle","status":"Active","login":"bob","last_login":"2023-05-01T09:12:28Z","cookies_accepted_at":"2023-05-01T09:12:28Z","preferred_language":"en-US"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/users","jsonRequestBodyExample":{"users":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"myusername","email":"test@sailpoint.com","type":"NeprofileUser","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","title":"mytitle","status":"Active","login":"mylogin","admin":false,"group_strings":"Administrator_group,Developer_group"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update multiple users","description":{"content":"Update multiple users","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update multiple users' (patch-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update multiple users + + + +Update multiple users + +
Request Body required
    users object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    users object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/patch-workflow-session.api.mdx b/products/nerm/api/patch-workflow-session.api.mdx new file mode 100644 index 000000000..60a3aa7a5 --- /dev/null +++ b/products/nerm/api/patch-workflow-session.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-workflow-session +sidebar_label: Update a workflow session by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchWorkflowSession","description":"Update a workflow session by id","tags":["Workflow Sessions"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"run","in":"query","description":"Will run the created/updated workflow session if successful","required":false,"schema":{"type":"boolean","default":false},"example":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"workflow_id":{"description":"the workflow_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"the requester_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"the requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df94"]},"status":{"description":"the status","type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"workflow_id":{"description":"The workflow id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"the requester id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"The requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t"]},"status":{"description":"The status","type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/workflow_sessions/{id}","jsonRequestBodyExample":{"workflow_session":{"workflow_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","requester_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","requester_type":"User","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_ids":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df94"],"status":"completed","attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a workflow session by id","description":{"content":"Update a workflow session by id","type":"text/plain"},"url":{"path":["workflow_sessions",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Will run the created/updated workflow session if successful","type":"text/plain"},"key":"run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a workflow session by id' (patch-workflow-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a workflow session by id + + + +Update a workflow session by id + +
Path Parameters
Query Parameters
Request Body required
    workflow_session object
    attributes object
    + +the attributes + +
  • property name* string
+ +Expected response to a valid request + +
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +The attributes + +
  • property name* string
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-advanced-search.api.mdx b/products/nerm/api/post-advanced-search.api.mdx new file mode 100644 index 000000000..473954861 --- /dev/null +++ b/products/nerm/api/post-advanced-search.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-advanced-search +sidebar_label: Save an advanced search query for later use +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postAdvancedSearch","description":"Save an advanced search query for later use","tags":["Advanced Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"advanced_search":{"type":"object","properties":{"label":{"description":"the label","type":"string","example":"my search label"},"condition_rules_attributes":{"description":"The condition rules attributes","type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileTypeRule"],"example":"ProfileTypeRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"type":{"description":"the type","type":"string","required":true,"enum":["ProfileStatusRule"],"example":"ProfileStatusRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","required":true,"enum":["Active","Inactive","Leave of absence","Terminated"],"example":"Active"}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"],"example":"TextAreaAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"the operator to use for comparison","type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"],"example":"=="},"value":{"description":"the value to use for comparison","type":"string","required":true,"example":"Some value"}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["DateAttribute"],"example":"DateAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_attribute_type":{"description":"The secondary_attribute_type","type":"string","enum":["DateAttribute"],"example":"DateAttribute"},"secondary_attribute_id":{"description":"The secondary_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use when comparing","type":"string","enum":[">","<","after","before"],"example":"after"},"value":{"description":"The value","type":"string","required":true,"enum":["Today",""],"example":"Today"},"secondary_value":{"description":"The secondary_value","type":"string","enum":["after","before"],"example":"after"},"tertiary_value":{"description":"The tertiary_value","type":"string","example":30}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The conditon object type","type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"],"example":"ProfileSearchAttribute"},"condition_object_id":{"description":"The condition object id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["include?","exclude?"],"example":"include?"},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["RiskRule"],"example":"RiskRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==",">","<"],"example":"=="},"value":{"description":"The value to use","type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_value":{"description":"The secondary value to use","type":"string","required":true,"enum":["OverallRisk"],"example":"OverallRisk"}}}]},"example":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"advanced_search":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"label":{"description":"the label","type":"string","example":"mylabel"},"condition_rules_attributes":{"description":"The condition rules attributes","type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uuid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileTypeRule"],"example":"ProfileTypeRule"},"comparison_operator":{"description":"The comparison operator","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileStatusRule"],"example":"ProfileStatusRule"},"comparison_operator":{"description":"The comparison operator","type":"string","enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","enum":["Active","Inactive","Leave of absence","Terminated"],"example":"Active"}}},{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"],"example":"TextAreaAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"],"example":"=="},"value":{"description":"The value","type":"string","required":true,"example":"Some value"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition object type","type":"string","required":true,"enum":["DateAttribute"],"example":"DateAttribute"},"condition_object_id":{"description":"The condition object id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_attribute_type":{"description":"The secondary_attribute_type","type":"string","enum":["DateAttribute"],"example":"DateAttribute"},"secondary_attribute_id":{"description":"The secondary_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":[">","<","after","before"],"example":"<"},"value":{"description":"The value to use for comparison","type":"string","required":true,"enum":["Today",""],"example":"Today"},"secondary_value":{"description":"The secondary value","type":"string","enum":["after","before"],"example":"after"},"tertiary_value":{"description":"the tertiary_value","type":"string","example":30}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"],"example":"OwnerSearchAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The comparison_operator","type":"string","required":true,"enum":["include?","exclude?"],"example":"include?"},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"type":{"description":"The type","type":"string","required":true,"enum":["RiskRule"],"example":"RiskRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==",">","<"],"example":"=="},"value":{"description":"Id of the Risk Level being compared against","type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_value":{"description":"The secondary value","type":"string","required":true,"enum":["OverallRisk"],"example":"OverallRisk"}}}]},"example":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"type":"ProfileStatusRule","id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","comparison_operator":"==","value":"Active"}]}}}}}}}}},"method":"post","path":"/advanced_search","jsonRequestBodyExample":{"advanced_search":{"label":"my search label","condition_rules_attributes":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Save an advanced search query for later use","description":{"content":"Save an advanced search query for later use","type":"text/plain"},"url":{"path":["advanced_search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Save an advanced search query for later use' (post-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Save an advanced search query for later use + + + +Save an advanced search query for later use + +
Request Body required
    advanced_search object
    condition_rules_attributes object[]
    + +The condition rules attributes + +
    anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} defaultValue={undefined}>`, `<`, `after`, `before`]"} defaultValue={undefined}>`]"} defaultValue={undefined}>`, `<`]"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    advanced_search object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    condition_rules_attributes object[]
    + +The condition rules attributes + +
    anyOf= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`, `start_with?`, `end_with?`, `include?`]"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`, `after`, `before`]"} defaultValue={undefined}>`]"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}>`, `<`]"} defaultValue={undefined}>
\ No newline at end of file diff --git a/products/nerm/api/post-attribute-option.api.mdx b/products/nerm/api/post-attribute-option.api.mdx new file mode 100644 index 000000000..777a0977f --- /dev/null +++ b/products/nerm/api/post-attribute-option.api.mdx @@ -0,0 +1,35 @@ +--- +id: post-attribute-option +sidebar_label: Add a value to an option based attribute +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postAttributeOption","description":"Add a value to an option based attribute","tags":["Attribute Options"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_option":{"type":"object","properties":{"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"The option","type":"string","example":"option1"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_option":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"the option","type":"string","example":"myoption"}}}}}}}},"405":{"description":"Invalid input"}},"method":"post","path":"/ne_attribute_option","jsonRequestBodyExample":{"ne_attribute_option":{"ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","option":"option1"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Add a value to an option based attribute","description":{"content":"Add a value to an option based attribute","type":"text/plain"},"url":{"path":["ne_attribute_option"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Add a value to an option based attribute' (post-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Add a value to an option based attribute + + + +Add a value to an option based attribute + +
Request Body required
    ne_attribute_option object
+ +Expected response to a valid request + +
Schema
    ne_attribute_option object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Invalid input + +
\ No newline at end of file diff --git a/products/nerm/api/post-attribute-options.api.mdx b/products/nerm/api/post-attribute-options.api.mdx new file mode 100644 index 000000000..120188f16 --- /dev/null +++ b/products/nerm/api/post-attribute-options.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-attribute-options +sidebar_label: Create multiple new option based attribute values +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postAttributeOptions","description":"Create multiple new option based attribute values","tags":["Attribute Options"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ne_attribute_options":{"type":"array","items":{"type":"object","properties":{"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"The option","type":"string","example":"option1"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"ne_attribute_options":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"option":{"description":"the option","type":"string","example":"myoption"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","option":"myoption1"},{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9d511","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9d511","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9d511","option":"myoption2"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/ne_attribute_options","jsonRequestBodyExample":{"ne_attribute_options":[{"ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","option":"option1"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple new option based attribute values","description":{"content":"Create multiple new option based attribute values","type":"text/plain"},"url":{"path":["ne_attribute_options"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple new option based attribute values' (post-attribute-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple new option based attribute values + + + +Create multiple new option based attribute values + +
Request Body required
    ne_attribute_options object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    ne_attribute_options object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-profile-avatar.api.mdx b/products/nerm/api/post-profile-avatar.api.mdx new file mode 100644 index 000000000..73c18a703 --- /dev/null +++ b/products/nerm/api/post-profile-avatar.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-profile-avatar +sidebar_label: Uploads a new profile avatar +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postProfileAvatar","description":"Uploads a new profile avatar","tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/profiles/{id}/avatar","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Uploads a new profile avatar","description":{"content":"Uploads a new profile avatar","type":"text/plain"},"url":{"path":["profiles",":id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads a new profile avatar' (post-profile-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads a new profile avatar + + + +Uploads a new profile avatar + +
Path Parameters
Request Body required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-profile-type.api.mdx b/products/nerm/api/post-profile-type.api.mdx new file mode 100644 index 000000000..fe7da723d --- /dev/null +++ b/products/nerm/api/post-profile-type.api.mdx @@ -0,0 +1,55 @@ +--- +id: post-profile-type +sidebar_label: Create a profile type +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postProfileType","description":"Create a profile type","tags":["Profile Types"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile_type":{"type":"object","properties":{"name":{"description":"The name","type":"string","example":"great_profile_type"},"bypass_dup_protection":{"description":"Bypass duplicate protection?","type":"boolean","default":false,"example":false},"archived":{"description":"Is this archived","type":"boolean","default":false,"example":false},"permitted_role_ids":{"description":"Permitted Role ids","type":"array","items":{"type":"string","format":"uuid"},"example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d"]},"profile_type_dup_attributes":{"description":"Profile type duplicate attribgutes","type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"The profile type ID","type":"string","format":"uuid","example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},"profile_type_namings":{"description":"The profile type namings","type":"array","items":{"description":"The items","type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"The profile_type_id","type":"string","format":"uuid","example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"order":{"description":"The order which this appears in","type":"integer","format":"int32","minimum":0,"example":0}}}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile_type":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile type"},"bypass_dup_protection":{"description":"bypass duplicate protection?","type":"boolean","example":false},"archived":{"description":"is this profile type archived?","type":"boolean","example":false},"permitted_role_ids":{"description":"permitted role_ids for this profile_type","type":"array","items":{"type":"string","format":"uuid"},"example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df92"]},"profile_type_dup_attributes":{"description":"The profile type duplicate attributes","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h"}]},"profile_type_namings":{"description":"the profile type namings","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"the ne attribute id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"order":{"description":"the order","type":"integer","format":"int32","minimum":0,"example":0}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h","order":0}]}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/profile_type","jsonRequestBodyExample":{"profile_type":{"name":"great_profile_type","bypass_dup_protection":false,"archived":false,"permitted_role_ids":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d"],"profile_type_dup_attributes":[{"id":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_type_id":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"profile_type_namings":[{"id":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_type_id":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","order":0}]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a profile type","description":{"content":"Create a profile type","type":"text/plain"},"url":{"path":["profile_type"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a profile type' (post-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a profile type + + + +Create a profile type + +
Request Body required
    profile_type object
    profile_type_dup_attributes object[]
    + +Profile type duplicate attribgutes + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_namings object[]
    + +The profile type namings + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    profile_type object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_dup_attributes object[]
    + +The profile type duplicate attributes + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    profile_type_namings object[]
    + +the profile type namings + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-profile-upload.api.mdx b/products/nerm/api/post-profile-upload.api.mdx new file mode 100644 index 000000000..681ca32b6 --- /dev/null +++ b/products/nerm/api/post-profile-upload.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-profile-upload +sidebar_label: Uploads a new attachment attribute value to a profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postProfileUpload","description":"Uploads a new attachment attribute value to a profile","tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"attribute_id","in":"path","description":"The id of the attachment attribute","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/profiles/{id}/upload/{attribute_id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Uploads a new attachment attribute value to a profile","description":{"content":"Uploads a new attachment attribute value to a profile","type":"text/plain"},"url":{"path":["profiles",":id","upload",":attribute_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The id of the attachment attribute","type":"text/plain"},"type":"any","value":"","key":"attribute_id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads a new attachment attribute value to a profile' (post-profile-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads a new attachment attribute value to a profile + + + +Uploads a new attachment attribute value to a profile + +
Path Parameters
Request Body required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-profile.api.mdx b/products/nerm/api/post-profile.api.mdx new file mode 100644 index 000000000..fff788b82 --- /dev/null +++ b/products/nerm/api/post-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-profile +sidebar_label: Create a profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postProfile","description":"Create a profile","tags":["Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"name":{"description":"The name","type":"string","example":"my profile name"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","required":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active","required":true},"id_proofing_status":{"description":"the id proofing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"archived":{"description":"is this profile archived","type":"boolean","default":false,"example":false},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/profile","jsonRequestBodyExample":{"profile":{"name":"my profile name","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","archived":false,"attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a profile","description":{"content":"Create a profile","type":"text/plain"},"url":{"path":["profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a profile' (post-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a profile + + + +Create a profile + +
Request Body required
    profile object
    attributes object
    + +the attributes + +
  • property name* string
+ +Expected response to a valid request + +
Schema
    profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-profiles.api.mdx b/products/nerm/api/post-profiles.api.mdx new file mode 100644 index 000000000..021e11525 --- /dev/null +++ b/products/nerm/api/post-profiles.api.mdx @@ -0,0 +1,51 @@ +--- +id: post-profiles +sidebar_label: Create multiple profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postProfiles","description":"Create multiple profiles","tags":["Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"name":{"description":"The name","type":"string","example":"my profile name"},"profile_type_id":{"description":"the profile type id","type":"string","format":"uuid","required":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active","required":true},"id_proofing_status":{"description":"the id proofing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"archived":{"description":"is this profile archived","type":"boolean","default":false,"example":false},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"my profile","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","created_at":"2023-05-01T09:12:28Z","updated_at":"2023-05-01T09:12:28Z","attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/profiles","jsonRequestBodyExample":{"profiles":[{"name":"my profile name","profile_type_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","status":"Active","id_proofing_status":"pending","archived":false,"attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple profiles","description":{"content":"Create multiple profiles","type":"text/plain"},"url":{"path":["profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple profiles' (post-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple profiles + + + +Create multiple profiles + +
Request Body required
    profiles object[]
    attributes object
    + +the attributes + +
  • property name* string
+ +Expected response to a valid request + +
Schema
    oneOf
    profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
    • job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-role-profile.api.mdx b/products/nerm/api/post-role-profile.api.mdx new file mode 100644 index 000000000..1d923a1b7 --- /dev/null +++ b/products/nerm/api/post-role-profile.api.mdx @@ -0,0 +1,35 @@ +--- +id: post-role-profile +sidebar_label: Create a role-profile contributor relationship +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postRoleProfile","description":"Create a role-profile contributor relationship","tags":["Role Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role_profile":{"type":"object","properties":{"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role_profile":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"405":{"description":"Invalid input"}},"method":"post","path":"/role_profile","jsonRequestBodyExample":{"role_profile":{"role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a role-profile contributor relationship","description":{"content":"Create a role-profile contributor relationship","type":"text/plain"},"url":{"path":["role_profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a role-profile contributor relationship' (post-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a role-profile contributor relationship + + + +Create a role-profile contributor relationship + +
Request Body required
    role_profile object
+ +Expected response to a valid request + +
Schema
    role_profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Invalid input + +
\ No newline at end of file diff --git a/products/nerm/api/post-role-profiles.api.mdx b/products/nerm/api/post-role-profiles.api.mdx new file mode 100644 index 000000000..669026432 --- /dev/null +++ b/products/nerm/api/post-role-profiles.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-role-profiles +sidebar_label: Create multiple role-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postRoleProfiles","description":"Create multiple role-profile contributor relationships","tags":["Role Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role_profiles":{"type":"array","items":{"type":"object","properties":{"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"role_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/role_profiles","jsonRequestBodyExample":{"role_profiles":[{"role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple role-profile contributor relationships","description":{"content":"Create multiple role-profile contributor relationships","type":"text/plain"},"url":{"path":["role_profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple role-profile contributor relationships' (post-role-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple role-profile contributor relationships + + + +Create multiple role-profile contributor relationships + +
Request Body required
    role_profiles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    role_profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-role.api.mdx b/products/nerm/api/post-role.api.mdx new file mode 100644 index 000000000..d8432398e --- /dev/null +++ b/products/nerm/api/post-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-role +sidebar_label: Create a new role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postRole","description":"Create a new role","tags":["Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"},"type":{"description":"The role type","type":"string","enum":["NeprofileRole","NeaccessRole"],"example":"NeaccessRole"},"name":{"description":"The role name","type":"string","example":"Sponsors"},"groups":{"description":"The role's groups","type":"array","items":{"type":"string","example":"ad_group_name"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/role","jsonRequestBodyExample":{"role":{"uid":"sponsors_role","type":"NeaccessRole","name":"Sponsors","groups":["ad_group_name"]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a new role","description":{"content":"Create a new role","type":"text/plain"},"url":{"path":["role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new role' (post-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a new role + + + +Create a new role + +
Request Body required
    role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-roles.api.mdx b/products/nerm/api/post-roles.api.mdx new file mode 100644 index 000000000..0c399ffb1 --- /dev/null +++ b/products/nerm/api/post-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-roles +sidebar_label: Create multiple new roles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postRoles","description":"Create multiple new users","tags":["Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"},"type":{"description":"The role type","type":"string","enum":["NeprofileRole","NeaccessRole"],"example":"NeaccessRole"},"name":{"description":"The role name","type":"string","example":"Sponsors"},"groups":{"description":"The role's groups","type":"array","items":{"type":"string","example":"ad_group_name"}}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"roles":{"description":"the list of roles","type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"},"name":{"description":"The name","type":"string","example":"Sponsors"},"groups":{"description":"the groups","type":"array","items":{"type":"string"},"example":["ad_group_name"]}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"sponsors_role","name":"Sponsors","groups":["ad_group_name"]}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/roles","jsonRequestBodyExample":{"roles":[{"uid":"sponsors_role","type":"NeaccessRole","name":"Sponsors","groups":["ad_group_name"]}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple new roles","description":{"content":"Create multiple new users","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple new roles' (post-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple new roles + + + +Create multiple new users + +
Request Body required
    roles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    oneOf
    roles object[]
    + +the list of roles + +
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user-avatar.api.mdx b/products/nerm/api/post-user-avatar.api.mdx new file mode 100644 index 000000000..f4ce4f2f2 --- /dev/null +++ b/products/nerm/api/post-user-avatar.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-user-avatar +sidebar_label: Uploads a new user avatar +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserAvatar","description":"Uploads a new user avatar","tags":["Users"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/users/{id}/avatar","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Uploads a new user avatar","description":{"content":"Uploads a new user avatar","type":"text/plain"},"url":{"path":["users",":id","avatar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads a new user avatar' (post-user-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads a new user avatar + + + +Uploads a new user avatar + +
Path Parameters
Request Body required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user-manager.api.mdx b/products/nerm/api/post-user-manager.api.mdx new file mode 100644 index 000000000..91e2139e7 --- /dev/null +++ b/products/nerm/api/post-user-manager.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-user-manager +sidebar_label: Create a new user-manager relationship +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserManager","description":"Create a new user-manager relationship","tags":["User Managers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_manager":{"type":"object","properties":{"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_manager":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/user_manager","jsonRequestBodyExample":{"user_manager":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","manager_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a new user-manager relationship","description":{"content":"Create a new user-manager relationship","type":"text/plain"},"url":{"path":["user_manager"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new user-manager relationship' (post-user-manager)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a new user-manager relationship + + + +Create a new user-manager relationship + +
Request Body required
    user_manager object
+ +Expected response to a valid request + +
Schema
    user_manager object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user-managers.api.mdx b/products/nerm/api/post-user-managers.api.mdx new file mode 100644 index 000000000..d6ae50651 --- /dev/null +++ b/products/nerm/api/post-user-managers.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-user-managers +sidebar_label: Create multiple new user-manager relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserManagers","description":"Create multiple new user-manager relationships","tags":["User Managers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_managers":{"type":"array","items":{"type":"object","properties":{"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}},{"type":"object","properties":{"user_managers":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"manager_id":{"description":"the manager id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h","manager_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9l"}]}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/user_managers","jsonRequestBodyExample":{"user_managers":[{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","manager_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple new user-manager relationships","description":{"content":"Create multiple new user-manager relationships","type":"text/plain"},"url":{"path":["user_managers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple new user-manager relationships' (post-user-managers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple new user-manager relationships + + + +Create multiple new user-manager relationships + +
Request Body required
    user_managers object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    job_status object
    + +the status of the job + +
    user_managers object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user-profile.api.mdx b/products/nerm/api/post-user-profile.api.mdx new file mode 100644 index 000000000..2a0d30865 --- /dev/null +++ b/products/nerm/api/post-user-profile.api.mdx @@ -0,0 +1,35 @@ +--- +id: post-user-profile +sidebar_label: Create a user-profile contributor relationship +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserProfile","description":"Create a user-profile contributor relationship","tags":["User Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_profile":{"type":"object","properties":{"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"the profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_profile":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}},"405":{"description":"Invalid input"}},"method":"post","path":"/user_profile","jsonRequestBodyExample":{"user_profile":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","relationship_type":"owner"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a user-profile contributor relationship","description":{"content":"Create a user-profile contributor relationship","type":"text/plain"},"url":{"path":["user_profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a user-profile contributor relationship' (post-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a user-profile contributor relationship + + + +Create a user-profile contributor relationship + +
Request Body required
    user_profile object
+ +Expected response to a valid request + +
Schema
    user_profile object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Invalid input + +
\ No newline at end of file diff --git a/products/nerm/api/post-user-profiles.api.mdx b/products/nerm/api/post-user-profiles.api.mdx new file mode 100644 index 000000000..64c692248 --- /dev/null +++ b/products/nerm/api/post-user-profiles.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-user-profiles +sidebar_label: Create multiple user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserProfiles","description":"Create multiple user-profile contributor relationships","tags":["User Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_profiles":{"type":"array","items":{"type":"object","properties":{"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"the profile id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship type","type":"string","enum":["owner","contributor"],"example":"owner"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"user_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"The user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"ne_attribute_id":{"description":"The ne_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"relationship_type":{"description":"the relationship_type","type":"string","enum":["owner","contributor"],"example":"owner"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","relationship_type":"owner"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/user_profiles","jsonRequestBodyExample":{"user_profiles":[{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","ne_attribute_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","relationship_type":"owner"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple user-profile contributor relationships","description":{"content":"Create multiple user-profile contributor relationships","type":"text/plain"},"url":{"path":["user_profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple user-profile contributor relationships' (post-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple user-profile contributor relationships + + + +Create multiple user-profile contributor relationships + +
Request Body required
    user_profiles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user-role.api.mdx b/products/nerm/api/post-user-role.api.mdx new file mode 100644 index 000000000..f6d2acecf --- /dev/null +++ b/products/nerm/api/post-user-role.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-user-role +sidebar_label: Assign a new role to a user +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserRole","description":"Assign a new role to a user","tags":["User Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/user_role","jsonRequestBodyExample":{"user_role":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Assign a new role to a user","description":{"content":"Assign a new role to a user","type":"text/plain"},"url":{"path":["user_role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Assign a new role to a user' (post-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Assign a new role to a user + + + +Assign a new role to a user + +
Request Body required
    user_role object
+ +Expected response to a valid request + +
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user-roles.api.mdx b/products/nerm/api/post-user-roles.api.mdx new file mode 100644 index 000000000..4538ecfed --- /dev/null +++ b/products/nerm/api/post-user-roles.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-user-roles +sidebar_label: Create multiple new user role pairings +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUserRoles","description":"Create multiple new user role pairings","tags":["User Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_roles":{"type":"array","items":{"type":"object","properties":{"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"user_roles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9a","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b","user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9c","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/user_roles","jsonRequestBodyExample":{"user_roles":[{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple new user role pairings","description":{"content":"Create multiple new user role pairings","type":"text/plain"},"url":{"path":["user_roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple new user role pairings' (post-user-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple new user role pairings + + + +Create multiple new user role pairings + +
Request Body required
    user_roles object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_roles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-user.api.mdx b/products/nerm/api/post-user.api.mdx new file mode 100644 index 000000000..32bb47fcf --- /dev/null +++ b/products/nerm/api/post-user.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-user +sidebar_label: Create a new user +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUser","description":"Create a new user","tags":["Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"description":"The users name","type":"string","required":true,"example":"bob"},"email":{"description":"Email","type":"string","format":"email","required":true,"example":"test@sailpoint.com"},"type":{"description":"The user type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"profile_id":{"description":"The user profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"title":{"description":"The user title","type":"string","example":"my_user_title"},"status":{"description":"The user status","type":"string","enum":["Active","Disabled"],"required":true,"example":"Active"},"login":{"description":"The user login","type":"string","required":true,"example":"my_user"},"admin":{"description":"Is the user an admin","type":"boolean","default":false,"example":false},"group_strings":{"description":"The users group strings","type":"string","example":"Administrator_group,Developer_group"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/user","jsonRequestBodyExample":{"user":{"name":"bob","email":"test@sailpoint.com","type":"NeprofileUser","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","title":"my_user_title","status":"Active","login":"my_user","admin":false,"group_strings":"Administrator_group,Developer_group"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a new user","description":{"content":"Create a new user","type":"text/plain"},"url":{"path":["user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new user' (post-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a new user + + + +Create a new user + +
Request Body required
    user object
+ +Expected response to a valid request + +
Schema
    user object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-users.api.mdx b/products/nerm/api/post-users.api.mdx new file mode 100644 index 000000000..c90f7ca15 --- /dev/null +++ b/products/nerm/api/post-users.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-users +sidebar_label: Create multiple new users +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postUsers","description":"Create multiple new users","tags":["Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"name":{"description":"The users name","type":"string","required":true,"example":"bob"},"email":{"description":"Email","type":"string","format":"email","required":true,"example":"test@sailpoint.com"},"type":{"description":"The user type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"profile_id":{"description":"The user profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"title":{"description":"The user title","type":"string","example":"my_user_title"},"status":{"description":"The user status","type":"string","enum":["Active","Disabled"],"required":true,"example":"Active"},"login":{"description":"The user login","type":"string","required":true,"example":"my_user"},"admin":{"description":"Is the user an admin","type":"boolean","default":false,"example":false},"group_strings":{"description":"The users group strings","type":"string","example":"Administrator_group,Developer_group"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}},"example":[{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","uid":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"bob","email":"example@sailpoint.com","type":"NeprofileUser","title":"mytitle","status":"Active","login":"bob","last_login":"2023-05-01T09:12:28Z","cookies_accepted_at":"2023-05-01T09:12:28Z","preferred_language":"en-US"}]}}},{"type":"object","properties":{"info":{"description":"info about the job","type":"string","example":"job has started"},"job_status":{"description":"the status of the job","type":"object","properties":{"job_id":{"description":"the job id","type":"string","example":"3ce88e47ad6dba2ddf349d21"},"status":{"description":"the status","type":"string","example":"queued"}}},"status":{"description":"the status","type":"integer","format":"int32","example":200}}}]}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/users","jsonRequestBodyExample":{"users":[{"name":"bob","email":"test@sailpoint.com","type":"NeprofileUser","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","title":"my_user_title","status":"Active","login":"my_user","admin":false,"group_strings":"Administrator_group,Developer_group"}]},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create multiple new users","description":{"content":"Create multiple new users","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create multiple new users' (post-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create multiple new users + + + +Create multiple new users + +
Request Body required
    users object[]
+ +Expected response to a valid request + +
Schema
    oneOf
    users object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    job_status object
    + +the status of the job + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-workflow-session-upload.api.mdx b/products/nerm/api/post-workflow-session-upload.api.mdx new file mode 100644 index 000000000..08d3222d7 --- /dev/null +++ b/products/nerm/api/post-workflow-session-upload.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-workflow-session-upload +sidebar_label: Uploads a new attachment attribute value to a workflow session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postWorkflowSessionUpload","description":"Uploads a new attachment attribute value to a workflow session","tags":["Workflow Sessions"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"attribute_id","in":"path","description":"The id of the attachment attribute","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url","type":"string","format":"url","readOnly":true,"example":"http://www.example.com"}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/workflow_sessions/{id}/upload/{attribute_id}","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Uploads a new attachment attribute value to a workflow session","description":{"content":"Uploads a new attachment attribute value to a workflow session","type":"text/plain"},"url":{"path":["workflow_sessions",":id","upload",":attribute_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The id of the attachment attribute","type":"text/plain"},"type":"any","value":"","key":"attribute_id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads a new attachment attribute value to a workflow session' (post-workflow-session-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads a new attachment attribute value to a workflow session + + + +Uploads a new attachment attribute value to a workflow session + +
Path Parameters
Request Body required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/post-workflow-session.api.mdx b/products/nerm/api/post-workflow-session.api.mdx new file mode 100644 index 000000000..86b832deb --- /dev/null +++ b/products/nerm/api/post-workflow-session.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-workflow-session +sidebar_label: Create a workflow session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postWorkflowSession","description":"Create a workflow session","tags":["Workflow Sessions"],"parameters":[{"name":"run","in":"query","description":"Will run the created/updated workflow session if successful","required":false,"schema":{"type":"boolean","default":false},"example":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"workflow_id":{"description":"The workflow id","type":"string","format":"uuid","required":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"The requester id","type":"string","format":"uuid","required":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"The requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"required":true,"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f"]},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"workflow_id":{"description":"The workflow id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_id":{"description":"the requester id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"requester_type":{"description":"The requester type","type":"string","enum":["User","NeprofileUser","NeaccessUser"],"example":"User"},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows","example":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t"]},"status":{"description":"The status","type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"},"attributes":{"description":"The attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"post","path":"/workflow_sessions","jsonRequestBodyExample":{"workflow_session":{"workflow_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","requester_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","requester_type":"User","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","profile_ids":["db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f"],"attributes":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Create a workflow session","description":{"content":"Create a workflow session","type":"text/plain"},"url":{"path":["workflow_sessions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Will run the created/updated workflow session if successful","type":"text/plain"},"key":"run","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a workflow session' (post-workflow-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a workflow session + + + +Create a workflow session + +
Query Parameters
Request Body required
    workflow_session object
    attributes object
    + +The attributes + +
  • property name* string
+ +Expected response to a valid request + +
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +The attributes + +
  • property name* string
+ +Bad Request - unable to complete. + +
Schema
    oneOf
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/products/nerm/api/run-advanced-search.api.mdx b/products/nerm/api/run-advanced-search.api.mdx new file mode 100644 index 000000000..b485e8316 --- /dev/null +++ b/products/nerm/api/run-advanced-search.api.mdx @@ -0,0 +1,39 @@ +--- +id: run-advanced-search +sidebar_label: Run an advanced search for profiles, without saving the query +hide_title: true +hide_table_of_contents: true +api: {"operationId":"runAdvancedSearch","description":"Run an advanced search for profiles, without saving the query","tags":["Advanced Search"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"advanced_search":{"type":"object","properties":{"label":{"description":"the label","type":"string","example":"my search label"},"condition_rules_attributes":{"description":"The condition rules attributes","type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileTypeRule"],"example":"ProfileTypeRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"type":{"description":"the type","type":"string","required":true,"enum":["ProfileStatusRule"],"example":"ProfileStatusRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["==","!="],"example":"=="},"value":{"description":"The value","type":"string","required":true,"enum":["Active","Inactive","Leave of absence","Terminated"],"example":"Active"}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["TextFieldAttribute","TextAreaAttribute"],"example":"TextAreaAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"the operator to use for comparison","type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"],"example":"=="},"value":{"description":"the value to use for comparison","type":"string","required":true,"example":"Some value"}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The condition_object_type","type":"string","required":true,"enum":["DateAttribute"],"example":"DateAttribute"},"condition_object_id":{"description":"The condition_object_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_attribute_type":{"description":"The secondary_attribute_type","type":"string","enum":["DateAttribute"],"example":"DateAttribute"},"secondary_attribute_id":{"description":"The secondary_attribute_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use when comparing","type":"string","enum":[">","<","after","before"],"example":"after"},"value":{"description":"The value","type":"string","required":true,"enum":["Today",""],"example":"Today"},"secondary_value":{"description":"The secondary_value","type":"string","enum":["after","before"],"example":"after"},"tertiary_value":{"description":"The tertiary_value","type":"string","example":30}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["ProfileAttributeRule"],"example":"ProfileAttributeRule"},"condition_object_type":{"description":"The conditon object type","type":"string","required":true,"enum":["ProfileSelectAttribute","ProfileSearchAttribute","OwnerSelectAttribute","OwnerSearchAttribute","ContributorSelectAttribute","ContributorSearchAttribute"],"example":"ProfileSearchAttribute"},"condition_object_id":{"description":"The condition object id","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","required":true,"enum":["include?","exclude?"],"example":"include?"},"value":{"description":"The value","type":"string","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}},{"type":"object","properties":{"type":{"description":"The type","type":"string","required":true,"enum":["RiskRule"],"example":"RiskRule"},"comparison_operator":{"description":"The operator to use for comparison","type":"string","enum":["==",">","<"],"example":"=="},"value":{"description":"The value to use","type":"string","summary":"id of the Risk Level being compared against","required":true,"format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"secondary_value":{"description":"The secondary value to use","type":"string","required":true,"enum":["OverallRisk"],"example":"OverallRisk"}}}]},"example":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}}}},"method":"post","path":"/advanced_search/run","jsonRequestBodyExample":{"advanced_search":{"label":"my search label","condition_rules_attributes":[{"type":"ProfileTypeRule","comparison_operator":"==","value":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}]}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Run an advanced search for profiles, without saving the query","description":{"content":"Run an advanced search for profiles, without saving the query","type":"text/plain"},"url":{"path":["advanced_search","run"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Run an advanced search for profiles, without saving the query' (run-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Run an advanced search for profiles, without saving the query + + + +Run an advanced search for profiles, without saving the query + +
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
Request Body required
    advanced_search object
    condition_rules_attributes object[]
    + +The condition rules attributes + +
    anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} defaultValue={undefined}>`, `<`, `after`, `before`]"} defaultValue={undefined}>`]"} defaultValue={undefined}>`, `<`]"} defaultValue={undefined}>
+ +Expected response to a valid request + +
Schema
    profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
\ No newline at end of file diff --git a/products/nerm/api/run-advanced-searchby-id.api.mdx b/products/nerm/api/run-advanced-searchby-id.api.mdx new file mode 100644 index 000000000..3a817c12d --- /dev/null +++ b/products/nerm/api/run-advanced-searchby-id.api.mdx @@ -0,0 +1,35 @@ +--- +id: run-advanced-searchby-id +sidebar_label: Run a saved advanced search query +hide_title: true +hide_table_of_contents: true +api: {"operationId":"runAdvancedSearchbyID","description":"Run a saved advanced search query","tags":["Advanced Search"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n
\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"text_attribute_uid":"static text","date_attribute_uid":"01/15/2020","profile_select_attribute_uid":"Profile Name","multiple_profile_select_attribute_uid":"Profile Name,Second Profile Name,Third Profile Name","contributor_select_attribute_uid":"User Name","multiple_contributor_select_attribute_uid":"User Name,Second User Name,Third User Name"}}}}}}}}}}},"method":"get","path":"/advanced_search/{id}/run","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Run a saved advanced search query","description":{"content":"Run a saved advanced search query","type":"text/plain"},"url":{"path":["advanced_search",":id","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: nerm/api/nerm-lifecycle-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Run a saved advanced search query' (run-advanced-searchby-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Run a saved advanced search query + + + +Run a saved advanced search query + +
Path Parameters
Query Parameters
    \n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    \n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}>
+ +Expected response to a valid request + +
Schema
    profiles object[]
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
    + +the attributes + +
  • property name* string
\ No newline at end of file diff --git a/products/nerm/api/sidebar.js b/products/nerm/api/sidebar.js new file mode 100644 index 000000000..2115d5a32 --- /dev/null +++ b/products/nerm/api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/nerm-lifecycle-api"},{"type":"category","label":"Users","items":[{"type":"doc","id":"api/post-user","label":"Create a new user","className":"api-method post"},{"type":"doc","id":"api/get-users","label":"Get users","className":"api-method get"},{"type":"doc","id":"api/post-users","label":"Create multiple new users","className":"api-method post"},{"type":"doc","id":"api/patch-users","label":"Update multiple users","className":"api-method patch"},{"type":"doc","id":"api/get-user","label":"Find user by id","className":"api-method get"},{"type":"doc","id":"api/patch-user","label":"Update a user by id","className":"api-method patch"},{"type":"doc","id":"api/delete-user","label":"Delete a user","className":"api-method delete"},{"type":"doc","id":"api/get-user-avatar","label":"Retrieves the URL of the user avatar","className":"api-method get"},{"type":"doc","id":"api/post-user-avatar","label":"Uploads a new user avatar","className":"api-method post"}]},{"type":"category","label":"User Managers","items":[{"type":"doc","id":"api/post-user-manager","label":"Create a new user-manager relationship","className":"api-method post"},{"type":"doc","id":"api/get-user-managers","label":"Get user-manager relationships","className":"api-method get"},{"type":"doc","id":"api/post-user-managers","label":"Create multiple new user-manager relationships","className":"api-method post"},{"type":"doc","id":"api/patch-user-managers","label":"Update multiple user-manager relationships","className":"api-method patch"},{"type":"doc","id":"api/get-user-manager","label":"Find user-manager relationship by id","className":"api-method get"},{"type":"doc","id":"api/patch-user-manager","label":"Update a user-manager relationship by id","className":"api-method patch"}]},{"type":"category","label":"Roles","items":[{"type":"doc","id":"api/get-roles","label":"Get roles","className":"api-method get"},{"type":"doc","id":"api/post-roles","label":"Create multiple new roles","className":"api-method post"},{"type":"doc","id":"api/patch-roles","label":"Update multiple roles","className":"api-method patch"},{"type":"doc","id":"api/post-role","label":"Create a new role","className":"api-method post"},{"type":"doc","id":"api/get-role","label":"Find role by id","className":"api-method get"},{"type":"doc","id":"api/patch-role","label":"Update an existing role","className":"api-method patch"}]},{"type":"category","label":"User Roles","items":[{"type":"doc","id":"api/post-user-role","label":"Assign a new role to a user","className":"api-method post"},{"type":"doc","id":"api/get-user-roles","label":"Get user role pairings","className":"api-method get"},{"type":"doc","id":"api/post-user-roles","label":"Create multiple new user role pairings","className":"api-method post"},{"type":"doc","id":"api/patch-user-roles","label":"Update multiple user role pairings","className":"api-method patch"},{"type":"doc","id":"api/get-user-role","label":"Find user role pairing by id","className":"api-method get"},{"type":"doc","id":"api/patch-user-role","label":"Update a user role pairing by id","className":"api-method patch"},{"type":"doc","id":"api/delete-user-role","label":"Delete a user role assignment","className":"api-method delete"}]},{"type":"category","label":"Attributes","items":[{"type":"doc","id":"api/get-attributes","label":"Get attribute data in bulk","className":"api-method get"},{"type":"doc","id":"api/get-attribute","label":"Find attribute data by id","className":"api-method get"}]},{"type":"category","label":"Attribute Options","items":[{"type":"doc","id":"api/post-attribute-option","label":"Add a value to an option based attribute","className":"api-method post"},{"type":"doc","id":"api/get-attribute-options","label":"Get option based attribute values","className":"api-method get"},{"type":"doc","id":"api/post-attribute-options","label":"Create multiple new option based attribute values","className":"api-method post"},{"type":"doc","id":"api/patch-attribute-options","label":"Update multiple option based attribute values","className":"api-method patch"},{"type":"doc","id":"api/get-attribute-option","label":"Find option based attribute value by id","className":"api-method get"},{"type":"doc","id":"api/patch-attribute-option","label":"Update a option based attribute value by id","className":"api-method patch"},{"type":"doc","id":"api/delete-attribute-option","label":"Delete a option based attribute value by id","className":"api-method delete"}]},{"type":"category","label":"Profile Types","items":[{"type":"doc","id":"api/post-profile-type","label":"Create a profile type","className":"api-method post"},{"type":"doc","id":"api/get-profile-types","label":"Get profile types","className":"api-method get"},{"type":"doc","id":"api/get-profile-type","label":"Find profile type by id","className":"api-method get"},{"type":"doc","id":"api/patch-profile-type","label":"Update a profile type by id","className":"api-method patch"},{"type":"doc","id":"api/delete-profile-type","label":"Delete profile type","className":"api-method delete"}]},{"type":"category","label":"Profiles","items":[{"type":"doc","id":"api/post-profile","label":"Create a profile","className":"api-method post"},{"type":"doc","id":"api/get-profiles","label":"Get profiles","className":"api-method get"},{"type":"doc","id":"api/post-profiles","label":"Create multiple profiles","className":"api-method post"},{"type":"doc","id":"api/patch-profiles","label":"Update multiple profiles","className":"api-method patch"},{"type":"doc","id":"api/delete-profiles","label":"Delete multiple profiles","className":"api-method delete"},{"type":"doc","id":"api/get-profile","label":"Find profile by id","className":"api-method get"},{"type":"doc","id":"api/patch-profile","label":"Update a profile by id","className":"api-method patch"},{"type":"doc","id":"api/get-profile-upload","label":"Retrieves the URL of an attachment attribute value from a profile","className":"api-method get"},{"type":"doc","id":"api/post-profile-upload","label":"Uploads a new attachment attribute value to a profile","className":"api-method post"},{"type":"doc","id":"api/get-profile-avatar","label":"Retrieves the URL of the profile avatar","className":"api-method get"},{"type":"doc","id":"api/post-profile-avatar","label":"Uploads a new profile avatar","className":"api-method post"}]},{"type":"category","label":"Risk Scores","items":[{"type":"doc","id":"api/get-risk-scores","label":"Get risk score data in bulk","className":"api-method get"},{"type":"doc","id":"api/get-risk-score","label":"Find risk score data by id","className":"api-method get"}]},{"type":"category","label":"Risk Levels","items":[{"type":"doc","id":"api/get-risk-levels","label":"Get risk level data in bulk","className":"api-method get"},{"type":"doc","id":"api/get-risk-level","label":"Find risk level data by id","className":"api-method get"}]},{"type":"category","label":"User Profiles","items":[{"type":"doc","id":"api/post-user-profile","label":"Create a user-profile contributor relationship","className":"api-method post"},{"type":"doc","id":"api/get-user-profiles","label":"Get user-profile contributor relationships","className":"api-method get"},{"type":"doc","id":"api/post-user-profiles","label":"Create multiple user-profile contributor relationships","className":"api-method post"},{"type":"doc","id":"api/patch-user-profiles","label":"Update multiple user-profile contributor relationships","className":"api-method patch"},{"type":"doc","id":"api/get-user-profile","label":"Find user-profile contributor relationship by id","className":"api-method get"},{"type":"doc","id":"api/patch-user-profile","label":"Update a user-profile contributor relationship by id","className":"api-method patch"},{"type":"doc","id":"api/delete-user-profile","label":"Delete a user profile assignment","className":"api-method delete"}]},{"type":"category","label":"Role Profiles","items":[{"type":"doc","id":"api/post-role-profile","label":"Create a role-profile contributor relationship","className":"api-method post"},{"type":"doc","id":"api/get-role-profiles","label":"Get role-profile contributor relationships","className":"api-method get"},{"type":"doc","id":"api/post-role-profiles","label":"Create multiple role-profile contributor relationships","className":"api-method post"},{"type":"doc","id":"api/patch-role-profiles","label":"Update multiple role-profile contributor relationships","className":"api-method patch"},{"type":"doc","id":"api/get-role-profile","label":"Find role-profile contributor relationship by id","className":"api-method get"},{"type":"doc","id":"api/patch-role-profile","label":"Update a role-profile contributor relationship by id","className":"api-method patch"},{"type":"doc","id":"api/delete-role-profile","label":"Delete a role profile assignment","className":"api-method delete"}]},{"type":"category","label":"Workflow Sessions","items":[{"type":"doc","id":"api/get-workflow-sessions","label":"Get workflow sessions","className":"api-method get"},{"type":"doc","id":"api/post-workflow-session","label":"Create a workflow session","className":"api-method post"},{"type":"doc","id":"api/get-workflow-session","label":"Find workflow session by id","className":"api-method get"},{"type":"doc","id":"api/patch-workflow-session","label":"Update a workflow session by id","className":"api-method patch"},{"type":"doc","id":"api/get-workflow-session-upload","label":"Retrieves the URL of an attachment attribute value from a workflow session","className":"api-method get"},{"type":"doc","id":"api/post-workflow-session-upload","label":"Uploads a new attachment attribute value to a workflow session","className":"api-method post"}]},{"type":"category","label":"Identity Proofing Results","items":[{"type":"doc","id":"api/get-identity-proofing-results","label":"Get identity proofing result data in bulk","className":"api-method get"}]},{"type":"category","label":"Advanced Search","items":[{"type":"doc","id":"api/get-advanced-search","label":"Get saved advanced search queries","className":"api-method get"},{"type":"doc","id":"api/post-advanced-search","label":"Save an advanced search query for later use","className":"api-method post"},{"type":"doc","id":"api/run-advanced-search","label":"Run an advanced search for profiles, without saving the query","className":"api-method post"},{"type":"doc","id":"api/patch-advanced-search","label":"Update a saved advanced search query","className":"api-method patch"},{"type":"doc","id":"api/run-advanced-searchby-id","label":"Run a saved advanced search query","className":"api-method get"}]},{"type":"category","label":"Job Status","items":[{"type":"doc","id":"api/get-job-status","label":"Get the status of a bulk job","className":"api-method get"}]}]; \ No newline at end of file diff --git a/products/nerm/sidebar.js b/products/nerm/sidebar.js new file mode 100644 index 000000000..1634da2bc --- /dev/null +++ b/products/nerm/sidebar.js @@ -0,0 +1,19 @@ +const sidebars = { + nermOpenApiSidebar: [ + { + type: 'category', + label: 'NERM API', + link: { + type: 'generated-index', + title: 'NERM API', + description: + "These are the Non-employee Lifecycle Management APIs for SailPoint. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", + slug: '/api', + }, + // @ts-ignore + items: require('./api/sidebar.js'), + }, + ], + }; + + module.exports = sidebars; \ No newline at end of file diff --git a/static/api-specs/nerm/openapi.yaml b/static/api-specs/nerm/openapi.yaml new file mode 100644 index 000000000..af8ef899c --- /dev/null +++ b/static/api-specs/nerm/openapi.yaml @@ -0,0 +1,119 @@ +openapi: "3.0.0" +info: + version: 1.0.0 + title: NERM Lifecycle API + description: The Lifecycle API can be used to access and modify various resources in your environment. + license: + name: MIT +paths: +# Users + /user: + $ref: "./paths/user.yaml" + /users: + $ref: "./paths/users.yaml" + /users/{id}: + $ref: "./paths/users_id.yaml" + /users/{id}/avatar: + $ref: "./paths/users_id_avatar.yaml" +# User Manager Relationships + /user_manager: + $ref: "./paths/user_manager.yaml" + /user_managers: + $ref: "./paths/user_managers.yaml" + /user_managers/{id}: + $ref: "./paths/user_managers_id.yaml" +# Roles + /roles: + $ref: "./paths/roles.yaml" + /role: + $ref: "./paths/role.yaml" + /roles/{id}: + $ref: "./paths/roles_id.yaml" +# User Roles + /user_role: + $ref: "./paths/user_role.yaml" + /user_roles: + $ref: "./paths/user_roles.yaml" + /user_roles/{id}: + $ref: "./paths/user_roles_id.yaml" + /user_role/{id}: + $ref: "./paths/user_role_id.yaml" +# Attributes + /ne_attributes: + $ref: "./paths/ne_attributes.yaml" + /ne_attributes/{id}: + $ref: "./paths/ne_attributes_id.yaml" + /ne_attribute_option: + $ref: "./paths/ne_attribute_option.yaml" + /ne_attribute_options: + $ref: "./paths/ne_attribute_options.yaml" + /ne_attribute_options/{id}: + $ref: "./paths/ne_attribute_options_id.yaml" +# Profile Types + /profile_type: + $ref: "./paths/profile_type.yaml" + /profile_types: + $ref: "./paths/profile_types.yaml" + /profile_types/{id}: + $ref: "./paths/profile_types_id.yaml" +# Profiles + /profile: + $ref: "./paths/profile.yaml" + /profiles: + $ref: "./paths/profiles.yaml" + /profiles/{id}: + $ref: "./paths/profiles_id.yaml" + /profiles/{id}/upload/{attribute_id}: + $ref: "./paths/profiles_id_upload_attribute_id.yaml" + /profiles/{id}/avatar: + $ref: "./paths/profiles_id_avatar.yaml" +# Risk Scores + /risk_scores: + $ref: "./paths/risk_scores.yaml" + /risk_scores/{id}: + $ref: "./paths/risk_scores_id.yaml" +# Risk Levels + /risk_levels: + $ref: "./paths/risk_levels.yaml" + /risk_levels/{id}: + $ref: "./paths/risk_levels_id.yaml" +# User Contributor Relationships + /user_profile: + $ref: "./paths/user_profile.yaml" + /user_profiles: + $ref: "./paths/user_profiles.yaml" + /user_profiles/{id}: + $ref: "./paths/user_profiles_id.yaml" + /user_profile/{id}: + $ref: "./paths/user_profile_id.yaml" +# Role Contributor Relationships + /role_profile: + $ref: "./paths/role_profile.yaml" + /role_profiles: + $ref: "./paths/role_profiles.yaml" + /role_profiles/{id}: + $ref: "./paths/role_profiles_id.yaml" + /role_profile/{id}: + $ref: "./paths/role_profile_id.yaml" +# Workflow Sessions + /workflow_sessions: + $ref: "./paths/workflow_sessions.yaml" + /workflow_sessions/{id}: + $ref: "./paths/workflow_sessions_id.yaml" + /workflow_sessions/{id}/upload/{attribute_id}: + $ref: "./paths/workflow_sessions_id_upload_attribute_id.yaml" +# Identity Proofing Results + /identity_proofing_results: + $ref: "./paths/identity_proofing_results.yaml" +# Advanced Search + /advanced_search: + $ref: "./paths/advanced_search.yaml" + /advanced_search/run: + $ref: "./paths/advanced_search_run.yaml" + /advanced_search/{id}: + $ref: "./paths/advanced_search_id.yaml" + /advanced_search/{id}/run: + $ref: "./paths/advanced_search_id_run.yaml" +# Jobs + /job_status: + $ref: "./paths/job_status.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/_index.yaml b/static/api-specs/nerm/parameters/_index.yaml new file mode 100644 index 000000000..3576a3d89 --- /dev/null +++ b/static/api-specs/nerm/parameters/_index.yaml @@ -0,0 +1,60 @@ +# Path +id: + $ref: './path/id.yaml' +attribute_id: + $ref: './path/attribute_id.yaml' +# Query +limit: + $ref: './query/limit.yaml' +offset: + $ref: './query/offset.yaml' +user_id: + $ref: './query/user_id.yaml' +manager_id: + $ref: './query/manager_id.yaml' +role_id: + $ref: './query/role_id.yaml' +label: + $ref: './query/label.yaml' +data_type: + $ref: './query/data_type.yaml' +ne_attribute_id: + $ref: './query/ne_attribute_id.yaml' +option: + $ref: './query/option.yaml' +name: + $ref: './query/name.yaml' +archived: + $ref: './query/archived.yaml' +profile_type_id: + $ref: './query/profile_type_id.yaml' +status: + $ref: './query/status.yaml' +object_id: + $ref: './query/object_id.yaml' +object_type: + $ref: './query/object_type.yaml' +overall_risk_level_id: + $ref: './query/overall_risk_level_id.yaml' +impact_risk_level_id: + $ref: './query/impact_risk_level_id.yaml' +probability_risk_level_id: + $ref: './query/probability_risk_level_id.yaml' +profile_id: + $ref: './query/profile_id.yaml' +relationship_type: + $ref: './query/relationship_type.yaml' +uid: + $ref: './query/uid.yaml' +workflow_id: + $ref: './query/workflow_id.yaml' +requester_id: + $ref: './query/requester_id.yaml' +status_uid: + $ref: './query/status_uid.yaml' +workflow_session_id: + $ref: './query/workflow_session_id.yaml' +result: + $ref: './query/result.yaml' +metadata: + $ref: './query/metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/path/attribute_id.yaml b/static/api-specs/nerm/parameters/path/attribute_id.yaml new file mode 100644 index 000000000..34096d73d --- /dev/null +++ b/static/api-specs/nerm/parameters/path/attribute_id.yaml @@ -0,0 +1,8 @@ +name: attribute_id +in: path +description: The id of the attachment attribute +required: true +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/path/id.yaml b/static/api-specs/nerm/parameters/path/id.yaml new file mode 100644 index 000000000..eb12f2812 --- /dev/null +++ b/static/api-specs/nerm/parameters/path/id.yaml @@ -0,0 +1,8 @@ +name: id +in: path +description: ID of the object to retrieve or update +required: true +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/archived.yaml b/static/api-specs/nerm/parameters/query/archived.yaml new file mode 100644 index 000000000..b357ed48c --- /dev/null +++ b/static/api-specs/nerm/parameters/query/archived.yaml @@ -0,0 +1,8 @@ +name: archived +in: query +description: Filter by archive status +required: false +schema: + type: boolean + default: false +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/data_type.yaml b/static/api-specs/nerm/parameters/query/data_type.yaml new file mode 100644 index 000000000..dc0cb0999 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/data_type.yaml @@ -0,0 +1,8 @@ +name: data_type +in: query +description: The attribute data type to filter by +required: false +schema: + type: string + enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search] +example: radio buttons \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/email.yaml b/static/api-specs/nerm/parameters/query/email.yaml new file mode 100644 index 000000000..4418305cd --- /dev/null +++ b/static/api-specs/nerm/parameters/query/email.yaml @@ -0,0 +1,8 @@ +name: email +in: query +description: The user email to search by +required: false +schema: + type: string + format: email +example: test@sailpoint.com \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/exclude_attributes.yaml b/static/api-specs/nerm/parameters/query/exclude_attributes.yaml new file mode 100644 index 000000000..45818ac49 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/exclude_attributes.yaml @@ -0,0 +1,8 @@ +name: exclude_attributes +in: query +description: Allows for optimization by not returning the associated attribute data for the returned profiles +required: false +schema: + type: boolean + default: false +example: true \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml b/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml new file mode 100644 index 000000000..2018f3e6f --- /dev/null +++ b/static/api-specs/nerm/parameters/query/impact_risk_level_id.yaml @@ -0,0 +1,9 @@ +name: impact_risk_level_id +in: query +description: Impact risk level to filter by +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/job_id.yaml b/static/api-specs/nerm/parameters/query/job_id.yaml new file mode 100644 index 000000000..ab37f29ce --- /dev/null +++ b/static/api-specs/nerm/parameters/query/job_id.yaml @@ -0,0 +1,7 @@ +name: job_id +in: query +description: The id of the job returned from a POST or PATCH endpoint that resulted in a job being created +required: true +schema: + type: string +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/label.yaml b/static/api-specs/nerm/parameters/query/label.yaml new file mode 100644 index 000000000..79b2fa488 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/label.yaml @@ -0,0 +1,7 @@ +name: label +in: query +description: The attribute label to filter by +required: false +example: mylabel +schema: + type: string \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/login.yaml b/static/api-specs/nerm/parameters/query/login.yaml new file mode 100644 index 000000000..e24061937 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/login.yaml @@ -0,0 +1,7 @@ +name: login +in: query +description: The user login to search by +required: false +schema: + type: string +example: myuser \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/manager_id.yaml b/static/api-specs/nerm/parameters/query/manager_id.yaml new file mode 100644 index 000000000..99cef40a7 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/manager_id.yaml @@ -0,0 +1,8 @@ +name: manager_id +in: query +description: The ID of a user for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/metadata.yaml b/static/api-specs/nerm/parameters/query/metadata.yaml new file mode 100644 index 000000000..3f684a8a9 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/metadata.yaml @@ -0,0 +1,8 @@ +name: metadata +in: query +description: Returns batching metadata in the response +required: false +example: true +schema: + type: boolean + default: false \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/name.yaml b/static/api-specs/nerm/parameters/query/name.yaml new file mode 100644 index 000000000..a0ad72942 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/name.yaml @@ -0,0 +1,7 @@ +name: name +in: query +description: object name for filtering +required: false +schema: + type: string +example: objectname diff --git a/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml b/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml new file mode 100644 index 000000000..38edb209b --- /dev/null +++ b/static/api-specs/nerm/parameters/query/ne_attribute_id.yaml @@ -0,0 +1,8 @@ +name: ne_attribute_id +in: query +description: ID of an attribute for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/object_id.yaml b/static/api-specs/nerm/parameters/query/object_id.yaml new file mode 100644 index 000000000..d5bcb301d --- /dev/null +++ b/static/api-specs/nerm/parameters/query/object_id.yaml @@ -0,0 +1,9 @@ +name: object_id +in: query +description: ID of an object for filtering. Used along with object_type +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/object_type.yaml b/static/api-specs/nerm/parameters/query/object_type.yaml new file mode 100644 index 000000000..86553d781 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/object_type.yaml @@ -0,0 +1,8 @@ +name: object_type +in: query +description: Type of object that object_id represents +required: false +schema: + type: string + enum: [Profile, WorkflowSession] +example: Profile \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/option.yaml b/static/api-specs/nerm/parameters/query/option.yaml new file mode 100644 index 000000000..cb7edb91b --- /dev/null +++ b/static/api-specs/nerm/parameters/query/option.yaml @@ -0,0 +1,7 @@ +name: option +in: query +description: attribute option label for filtering +required: false +schema: + type: string +example: my_option_label \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml b/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml new file mode 100644 index 000000000..3f4f2e3fa --- /dev/null +++ b/static/api-specs/nerm/parameters/query/overall_risk_level_id.yaml @@ -0,0 +1,8 @@ +name: overall_risk_level_id +in: query +description: Overall risk level to filter by +required: false +schema: + type: string + format: uuid +example: \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml b/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml new file mode 100644 index 000000000..d2ddbaf32 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/probability_risk_level_id.yaml @@ -0,0 +1,9 @@ +name: probability_risk_level_id +in: query +description: Probability risk level to filter by +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/profile_id.yaml b/static/api-specs/nerm/parameters/query/profile_id.yaml new file mode 100644 index 000000000..c12e6e1c1 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/profile_id.yaml @@ -0,0 +1,8 @@ +name: profile_id +in: query +description: Profile ID to filter by +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/profile_type_id.yaml b/static/api-specs/nerm/parameters/query/profile_type_id.yaml new file mode 100644 index 000000000..6728b2839 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/profile_type_id.yaml @@ -0,0 +1,8 @@ +name: profile_type_id +in: query +description: Profile Type ID for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/query.yaml b/static/api-specs/nerm/parameters/query/query.yaml new file mode 100644 index 000000000..7899ce9de --- /dev/null +++ b/static/api-specs/nerm/parameters/query/query.yaml @@ -0,0 +1,53 @@ +name: query +in: query +description: | + Allows for pagination and sorting using the deepObject notation. + +
+ + `resource?query[limit]=50&query[offset]=0&query[order]=label` + +
+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescriptionDefault
limitLimits the number of results returned100
offsetReturns the results starting at the value provided0
orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
+required: false +schema: + type: object + properties: + limit: + type: integer + description: The limit of results to return + example: 100 + offset: + type: integer + description: The number of records to offset + example: 50 + order: + type: string + description: The attribute to order by + example: created_at +style: deepObject +explode: true +example: query[limit]=100&query[offset]=50&query[order]=created_at diff --git a/static/api-specs/nerm/parameters/query/relationship_type.yaml b/static/api-specs/nerm/parameters/query/relationship_type.yaml new file mode 100644 index 000000000..a3c235c5b --- /dev/null +++ b/static/api-specs/nerm/parameters/query/relationship_type.yaml @@ -0,0 +1,8 @@ +name: relationship_type +in: query +description: Type of user contributor relationship to filter by +required: false +schema: + type: string + enum: [owner, contributor] +example: owner \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/requester_id.yaml b/static/api-specs/nerm/parameters/query/requester_id.yaml new file mode 100644 index 000000000..a8bf3468b --- /dev/null +++ b/static/api-specs/nerm/parameters/query/requester_id.yaml @@ -0,0 +1,8 @@ +name: requester_id +in: query +description: Requester ID for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/result.yaml b/static/api-specs/nerm/parameters/query/result.yaml new file mode 100644 index 000000000..430ffab9e --- /dev/null +++ b/static/api-specs/nerm/parameters/query/result.yaml @@ -0,0 +1,8 @@ +name: result +in: query +description: ID Proofing Result to filter by +required: false +schema: + type: string + enum: [pass, fail] +example: fail \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/role_id.yaml b/static/api-specs/nerm/parameters/query/role_id.yaml new file mode 100644 index 000000000..c454d3102 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/role_id.yaml @@ -0,0 +1,8 @@ +name: role_id +in: query +description: The ID of a role for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/run.yaml b/static/api-specs/nerm/parameters/query/run.yaml new file mode 100644 index 000000000..6821247e0 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/run.yaml @@ -0,0 +1,8 @@ +name: run +in: query +description: Will run the created/updated workflow session if successful +required: false +schema: + type: boolean + default: false +example: true \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/status.yaml b/static/api-specs/nerm/parameters/query/status.yaml new file mode 100644 index 000000000..ba852f24f --- /dev/null +++ b/static/api-specs/nerm/parameters/query/status.yaml @@ -0,0 +1,8 @@ +name: status +in: query +description: status value for filtering +required: false +schema: + type: string + enum: [Active, Inactive, On Leave, Terminated] +example: Active \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/title.yaml b/static/api-specs/nerm/parameters/query/title.yaml new file mode 100644 index 000000000..4f30ae8e0 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/title.yaml @@ -0,0 +1,7 @@ +name: title +in: query +description: The user title to search by +required: false +schema: + type: string +example: usertitle \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/uid.yaml b/static/api-specs/nerm/parameters/query/uid.yaml new file mode 100644 index 000000000..ae479401a --- /dev/null +++ b/static/api-specs/nerm/parameters/query/uid.yaml @@ -0,0 +1,9 @@ +name: uid +in: query +description: Workflow session uid for filtering +required: false +schema: + type: string + minLength: 32 + maxLength: 32 +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/user_id.yaml b/static/api-specs/nerm/parameters/query/user_id.yaml new file mode 100644 index 000000000..4859cdf16 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/user_id.yaml @@ -0,0 +1,8 @@ +name: user_id +in: query +description: The ID of a user for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/workflow_id.yaml b/static/api-specs/nerm/parameters/query/workflow_id.yaml new file mode 100644 index 000000000..9a34e2cb5 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/workflow_id.yaml @@ -0,0 +1,8 @@ +name: workflow_id +in: query +description: Workflow ID for filtering +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/workflow_session_id.yaml b/static/api-specs/nerm/parameters/query/workflow_session_id.yaml new file mode 100644 index 000000000..ac2e0323d --- /dev/null +++ b/static/api-specs/nerm/parameters/query/workflow_session_id.yaml @@ -0,0 +1,8 @@ +name: workflow_session_id +in: query +description: Workflow Session ID to filter by +required: false +schema: + type: string + format: uuid +example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/workflow_session_status.yaml b/static/api-specs/nerm/parameters/query/workflow_session_status.yaml new file mode 100644 index 000000000..7727342cc --- /dev/null +++ b/static/api-specs/nerm/parameters/query/workflow_session_status.yaml @@ -0,0 +1,71 @@ +name: status +in: query +description: filter by workflow session status +required: false +schema: + type: string + enum: [ + "waiting on workflow", + "identity proofing completed", + "new", + "closing", + "pending request", + "requested", + "pending approval", + "approved", + "pending notification", + "notified", + "pending review", + "reviewed", + "pending trigger", + "stored procedure", + "pending status change", + "status changed", + "pending update", + "non employee updated", + "non employee created", + "pending creation", + "rejected", + "pending assignment", + "assigned", + "default", + "failed", + "un assigned", + "auto assigned", + "ldap provided", + "pending ldap", + "pending fulfillment", + "pending stored procedure", + "pending courion add", + "fulfilled", + "pending courion update", + "courion add", + "pending courion_extend", + "courion update", + "pending courion terminate", + "courion extend", + "pending profile select", + "courion terminate", + "batch completed", + "profiles selected", + "answered questions", + "pending questions", + "attempting to start workflow", + "started workflow", + "profile check complete", + "completed", + "processing", + "pending set attribute", + "invitation sent", + "action skipped", + "api request sent", + "attribute set", + "disabled", + "duplicates resolved", + "soap request sent", + "checking for duplicates", + "pending identity proofing", + "closed", + "workflow changed" + ] +example: batch completed \ No newline at end of file diff --git a/static/api-specs/nerm/paths/advanced_search.yaml b/static/api-specs/nerm/paths/advanced_search.yaml new file mode 100644 index 000000000..c6f08618d --- /dev/null +++ b/static/api-specs/nerm/paths/advanced_search.yaml @@ -0,0 +1,20 @@ +get: + summary: Get saved advanced search queries + operationId: getAdvancedSearch + description: Get saved advanced search queries + tags: + - Advanced Search + responses: + '200': + $ref: "../responses/AdvancedSearches.yaml" +post: + summary: Save an advanced search query for later use + operationId: postAdvancedSearch + description: Save an advanced search query for later use + tags: + - Advanced Search + requestBody: + $ref: "../requestBodies/POST/AdvancedSearch.yaml" + responses: + '200': + $ref: "../responses/AdvancedSearch.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/advanced_search_id.yaml b/static/api-specs/nerm/paths/advanced_search_id.yaml new file mode 100644 index 000000000..76e6742c4 --- /dev/null +++ b/static/api-specs/nerm/paths/advanced_search_id.yaml @@ -0,0 +1,13 @@ +patch: + summary: Update a saved advanced search query + operationId: patchAdvancedSearch + description: Update a saved advanced search query + tags: + - Advanced Search + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/AdvancedSearch.yaml" + responses: + '200': + $ref: "../responses/AdvancedSearch.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/advanced_search_id_run.yaml b/static/api-specs/nerm/paths/advanced_search_id_run.yaml new file mode 100644 index 000000000..5edcd2fc8 --- /dev/null +++ b/static/api-specs/nerm/paths/advanced_search_id_run.yaml @@ -0,0 +1,12 @@ +get: + summary: Run a saved advanced search query + operationId: runAdvancedSearchbyID + description: Run a saved advanced search query + tags: + - Advanced Search + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/query/query.yaml" + responses: + '200': + $ref: "../responses/Profiles.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/advanced_search_run.yaml b/static/api-specs/nerm/paths/advanced_search_run.yaml new file mode 100644 index 000000000..c43cbe9c9 --- /dev/null +++ b/static/api-specs/nerm/paths/advanced_search_run.yaml @@ -0,0 +1,13 @@ +post: + summary: Run an advanced search for profiles, without saving the query + operationId: runAdvancedSearch + description: Run an advanced search for profiles, without saving the query + tags: + - Advanced Search + parameters: + - $ref: "../parameters/query/query.yaml" + requestBody: + $ref: "../requestBodies/POST/AdvancedSearch.yaml" + responses: + '200': + $ref: "../responses/Profiles.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/identity_proofing_results.yaml b/static/api-specs/nerm/paths/identity_proofing_results.yaml new file mode 100644 index 000000000..e613d9c14 --- /dev/null +++ b/static/api-specs/nerm/paths/identity_proofing_results.yaml @@ -0,0 +1,15 @@ +get: + summary: Get identity proofing result data in bulk + operationId: getIdentityProofingResults + description: This endpoint can retrieve identity proofing result data in bulk from Lifecycle + tags: + - Identity Proofing Results + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/workflow_session_id.yaml" + - $ref: "../parameters/query/result.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/IdentityProofingResults.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/job_status.yaml b/static/api-specs/nerm/paths/job_status.yaml new file mode 100644 index 000000000..ded7bb488 --- /dev/null +++ b/static/api-specs/nerm/paths/job_status.yaml @@ -0,0 +1,15 @@ +get: + summary: Get the status of a bulk job + operationId: getJobStatus + description: Get the status of a bulk job + tags: + - Job Status + parameters: + - $ref: "../parameters/query/job_id.yaml" + responses: + '200': + $ref: "../responses/Job.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/static/api-specs/nerm/paths/ne_attribute_option.yaml b/static/api-specs/nerm/paths/ne_attribute_option.yaml new file mode 100644 index 000000000..6023e09d9 --- /dev/null +++ b/static/api-specs/nerm/paths/ne_attribute_option.yaml @@ -0,0 +1,13 @@ +post: + summary: Add a value to an option based attribute + operationId: postAttributeOption + description: Add a value to an option based attribute + tags: + - Attribute Options + requestBody: + $ref: "../requestBodies/POST/AttributeOption.yaml" + responses: + '200': + $ref: "../responses/AttributeOption.yaml" + '405': + $ref: "../responses/InvalidInput.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/ne_attribute_options.yaml b/static/api-specs/nerm/paths/ne_attribute_options.yaml new file mode 100644 index 000000000..2c6cd6330 --- /dev/null +++ b/static/api-specs/nerm/paths/ne_attribute_options.yaml @@ -0,0 +1,48 @@ +get: + summary: Get option based attribute values + operationId: getAttributeOptions + description: Get option based attribute values + tags: + - Attribute Options + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/ne_attribute_id.yaml" +# - $ref: "../parameters/query/option.yaml" - Not implemented as of 4.16.2 + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/AttributeOptions_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new option based attribute values + operationId: postAttributeOptions + description: Create multiple new option based attribute values + tags: + - Attribute Options + requestBody: + $ref: "../requestBodies/POST/AttributeOptions.yaml" + responses: + '200': + $ref: "../responses/AttributeOptionsJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple option based attribute values + operationId: patchAttributeOptions + description: Update multiple option based attribute values + tags: + - Attribute Options + requestBody: + $ref: "../requestBodies/PATCH/AttributeOptions.yaml" + responses: + '200': + $ref: "../responses/AttributeOptionsJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/ne_attribute_options_id.yaml b/static/api-specs/nerm/paths/ne_attribute_options_id.yaml new file mode 100644 index 000000000..be4e3141f --- /dev/null +++ b/static/api-specs/nerm/paths/ne_attribute_options_id.yaml @@ -0,0 +1,47 @@ +get: + summary: Find option based attribute value by id + operationId: getAttributeOption + description: Info for a specific option based attribute value + tags: + - Attribute Options + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/AttributeOption.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a option based attribute value by id + operationId: patchAttributeOption + description: Update a option based attribute value by id + tags: + - Attribute Options + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/AttributeOption.yaml" + responses: + '200': + $ref: "../responses/AttributeOption.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +delete: + summary: Delete a option based attribute value by id + operationId: deleteAttributeOption + description: Delete a option based attribute value by id + tags: + - Attribute Options + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/DeleteConfirmation.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/ne_attributes.yaml b/static/api-specs/nerm/paths/ne_attributes.yaml new file mode 100644 index 000000000..77d2c4ce4 --- /dev/null +++ b/static/api-specs/nerm/paths/ne_attributes.yaml @@ -0,0 +1,18 @@ +get: + summary: Get attribute data in bulk + operationId: getAttributes + description: This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters + tags: + - Attributes + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/label.yaml" + - $ref: "../parameters/query/data_type.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Attributes_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/ne_attributes_id.yaml b/static/api-specs/nerm/paths/ne_attributes_id.yaml new file mode 100644 index 000000000..0f2cc3861 --- /dev/null +++ b/static/api-specs/nerm/paths/ne_attributes_id.yaml @@ -0,0 +1,15 @@ +get: + summary: Find attribute data by id + operationId: getAttribute + description: Info for a specific attribute + tags: + - Attributes + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Attribute.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profile.yaml b/static/api-specs/nerm/paths/profile.yaml new file mode 100644 index 000000000..6d6ad316f --- /dev/null +++ b/static/api-specs/nerm/paths/profile.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a profile + operationId: postProfile + description: Create a profile + tags: + - Profiles + requestBody: + $ref: "../requestBodies/POST/Profile.yaml" + responses: + '200': + $ref: "../responses/Profile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profile_type.yaml b/static/api-specs/nerm/paths/profile_type.yaml new file mode 100644 index 000000000..b6090dc3c --- /dev/null +++ b/static/api-specs/nerm/paths/profile_type.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a profile type + operationId: postProfileType + description: Create a profile type + tags: + - Profile Types + requestBody: + $ref: "../requestBodies/POST/ProfileType.yaml" + responses: + '200': + $ref: "../responses/ProfileType.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profile_types.yaml b/static/api-specs/nerm/paths/profile_types.yaml new file mode 100644 index 000000000..22e5df267 --- /dev/null +++ b/static/api-specs/nerm/paths/profile_types.yaml @@ -0,0 +1,18 @@ +get: + summary: Get profile types + operationId: getProfileTypes + description: Get option based attribute values + tags: + - Profile Types + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/name.yaml" + - $ref: "../parameters/query/archived.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/ProfileTypes_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/static/api-specs/nerm/paths/profile_types_id.yaml b/static/api-specs/nerm/paths/profile_types_id.yaml new file mode 100644 index 000000000..e81796b22 --- /dev/null +++ b/static/api-specs/nerm/paths/profile_types_id.yaml @@ -0,0 +1,48 @@ +get: + summary: Find profile type by id + operationId: getProfileType + description: Find profile type by id + tags: + - Profile Types + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/ProfileType.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a profile type by id + operationId: patchProfileType + description: Update a profile type by id + tags: + - Profile Types + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/ProfileType.yaml" + responses: + '200': + $ref: "../responses/ProfileType.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +# There is a foregin key constraint due to a profile profile_type_id dependency +delete: + summary: Delete profile type + operationId: deleteProfileType + description: Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. + tags: + - Profile Types + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/info.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profiles.yaml b/static/api-specs/nerm/paths/profiles.yaml new file mode 100644 index 000000000..009f895ee --- /dev/null +++ b/static/api-specs/nerm/paths/profiles.yaml @@ -0,0 +1,65 @@ +get: + summary: Get profiles + operationId: getProfiles + description: Get profiles + tags: + - Profiles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/exclude_attributes.yaml" + - $ref: "../parameters/query/name.yaml" + - $ref: "../parameters/query/profile_type_id.yaml" + - $ref: "../parameters/query/status.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Profiles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple profiles + operationId: postProfiles + description: Create multiple profiles + tags: + - Profiles + requestBody: + $ref: "../requestBodies/POST/Profiles.yaml" + responses: + '200': + $ref: "../responses/ProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple profiles + operationId: patchProfiles + description: Update multiple profiles + tags: + - Profiles + requestBody: + $ref: "../requestBodies/PATCH/Profiles.yaml" + responses: + '200': + $ref: "../responses/ProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +delete: + summary: Delete multiple profiles + operationId: deleteProfiles + description: Delete multiple profiles + tags: + - Profiles + requestBody: + $ref: "../requestBodies/DELETE/Profiles.yaml" + responses: + '200': + $ref: "../responses/ProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profiles_id.yaml b/static/api-specs/nerm/paths/profiles_id.yaml new file mode 100644 index 000000000..0dcc9987a --- /dev/null +++ b/static/api-specs/nerm/paths/profiles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find profile by id + operationId: getProfile + description: Find profile by id + tags: + - Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Profile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a profile by id + operationId: patchProfile + description: Update a profile by id + tags: + - Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/Profile.yaml" + responses: + '200': + $ref: "../responses/Profile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profiles_id_avatar.yaml b/static/api-specs/nerm/paths/profiles_id_avatar.yaml new file mode 100644 index 000000000..0d4e44113 --- /dev/null +++ b/static/api-specs/nerm/paths/profiles_id_avatar.yaml @@ -0,0 +1,32 @@ +get: + summary: Retrieves the URL of the profile avatar + operationId: getProfileAvatar + description: Retrieves the URL of the profile avatar + tags: + - Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new profile avatar + operationId: postProfileAvatar + description: Uploads a new profile avatar + tags: + - Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml b/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml new file mode 100644 index 000000000..34beae05b --- /dev/null +++ b/static/api-specs/nerm/paths/profiles_id_upload_attribute_id.yaml @@ -0,0 +1,34 @@ +get: + summary: Retrieves the URL of an attachment attribute value from a profile + operationId: getProfileUpload + description: Retrieves the URL of an attachment attribute value from a profile + tags: + - Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new attachment attribute value to a profile + operationId: postProfileUpload + description: Uploads a new attachment attribute value to a profile + tags: + - Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/risk_levels.yaml b/static/api-specs/nerm/paths/risk_levels.yaml new file mode 100644 index 000000000..423431b4c --- /dev/null +++ b/static/api-specs/nerm/paths/risk_levels.yaml @@ -0,0 +1,17 @@ +get: + summary: Get risk level data in bulk + operationId: getRiskLevels + description: This endpoint can retrieve risk level data in bulk from Lifecycle + tags: + - Risk Levels + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/label.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/RiskLevels_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/risk_levels_id.yaml b/static/api-specs/nerm/paths/risk_levels_id.yaml new file mode 100644 index 000000000..a8ec737d0 --- /dev/null +++ b/static/api-specs/nerm/paths/risk_levels_id.yaml @@ -0,0 +1,15 @@ +get: + summary: Find risk level data by id + operationId: getRiskLevel + description: Find risk level data by id + tags: + - Risk Levels + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/RiskLevel.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/risk_scores.yaml b/static/api-specs/nerm/paths/risk_scores.yaml new file mode 100644 index 000000000..38553734a --- /dev/null +++ b/static/api-specs/nerm/paths/risk_scores.yaml @@ -0,0 +1,21 @@ +get: + summary: Get risk score data in bulk + operationId: getRiskScores + description: This endpoint can retrieve risk score data in bulk from Lifecycle + tags: + - Risk Scores + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/object_id.yaml" + - $ref: "../parameters/query/object_type.yaml" + - $ref: "../parameters/query/overall_risk_level_id.yaml" + - $ref: "../parameters/query/impact_risk_level_id.yaml" + - $ref: "../parameters/query/probability_risk_level_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/RiskScores.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/risk_scores_id.yaml b/static/api-specs/nerm/paths/risk_scores_id.yaml new file mode 100644 index 000000000..f4853c5a6 --- /dev/null +++ b/static/api-specs/nerm/paths/risk_scores_id.yaml @@ -0,0 +1,15 @@ +get: + summary: Find risk score data by id + operationId: getRiskScore + description: Find risk score data by id + tags: + - Risk Scores + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/RiskScore.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/role.yaml b/static/api-specs/nerm/paths/role.yaml new file mode 100644 index 000000000..3ef66a33e --- /dev/null +++ b/static/api-specs/nerm/paths/role.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a new role + operationId: postRole + description: Create a new role + tags: + - Roles + requestBody: + $ref: "../requestBodies/POST/Role.yaml" + responses: + '200': + $ref: "../responses/Role.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/role_profile.yaml b/static/api-specs/nerm/paths/role_profile.yaml new file mode 100644 index 000000000..64f7fb2d5 --- /dev/null +++ b/static/api-specs/nerm/paths/role_profile.yaml @@ -0,0 +1,13 @@ +post: + summary: Create a role-profile contributor relationship + operationId: postRoleProfile + description: Create a role-profile contributor relationship + tags: + - Role Profiles + requestBody: + $ref: "../requestBodies/POST/RoleProfile.yaml" + responses: + '200': + $ref: "../responses/RoleProfile.yaml" + '405': + $ref: "../responses/InvalidInput.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/role_profile_id.yaml b/static/api-specs/nerm/paths/role_profile_id.yaml new file mode 100644 index 000000000..28d82c4c8 --- /dev/null +++ b/static/api-specs/nerm/paths/role_profile_id.yaml @@ -0,0 +1,19 @@ +delete: + summary: Delete a role profile assignment + operationId: deleteRoleProfile + description: Delete a role profile assignment + tags: + - Role Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + description: "Role profile was destroyed" + content: + application/json: + schema: + type: object + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/role_profiles.yaml b/static/api-specs/nerm/paths/role_profiles.yaml new file mode 100644 index 000000000..37d92bf6a --- /dev/null +++ b/static/api-specs/nerm/paths/role_profiles.yaml @@ -0,0 +1,48 @@ +get: + summary: Get role-profile contributor relationships + operationId: getRoleProfiles + description: Get role-profile contributor relationships + tags: + - Role Profiles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/role_id.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/RoleProfiles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple role-profile contributor relationships + operationId: postRoleProfiles + description: Create multiple role-profile contributor relationships + tags: + - Role Profiles + requestBody: + $ref: "../requestBodies/POST/RoleProfiles.yaml" + responses: + '200': + $ref: "../responses/RoleProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple role-profile contributor relationships + operationId: patchRoleProfiles + description: Update multiple role-profile contributor relationships + tags: + - Role Profiles + requestBody: + $ref: "../requestBodies/PATCH/RoleProfiles.yaml" + responses: + '200': + $ref: "../responses/RoleProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/role_profiles_id.yaml b/static/api-specs/nerm/paths/role_profiles_id.yaml new file mode 100644 index 000000000..7c90aa31d --- /dev/null +++ b/static/api-specs/nerm/paths/role_profiles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find role-profile contributor relationship by id + operationId: getRoleProfile + description: Find role-profile contributor relationship by id + tags: + - Role Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/RoleProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a role-profile contributor relationship by id + operationId: patchRoleProfile + description: Update a role-profile contributor relationship by id + tags: + - Role Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/RoleProfile.yaml" + responses: + '200': + $ref: "../responses/RoleProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/roles.yaml b/static/api-specs/nerm/paths/roles.yaml new file mode 100644 index 000000000..f17b829eb --- /dev/null +++ b/static/api-specs/nerm/paths/roles.yaml @@ -0,0 +1,46 @@ +get: + summary: Get roles + operationId: getRoles + description: This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. + tags: + - Roles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Roles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new roles + operationId: postRoles + description: Create multiple new users + tags: + - Roles + requestBody: + $ref: "../requestBodies/POST/Roles.yaml" + responses: + '200': + $ref: "../responses/RolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple roles + operationId: patchRoles + description: Update multiple users + tags: + - Roles + requestBody: + $ref: "../requestBodies/PATCH/Roles.yaml" + responses: + '200': + $ref: "../responses/RolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/roles_id.yaml b/static/api-specs/nerm/paths/roles_id.yaml new file mode 100644 index 000000000..db90e8f39 --- /dev/null +++ b/static/api-specs/nerm/paths/roles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find role by id + operationId: getRole + description: Info for a specific user role + tags: + - Roles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Role.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update an existing role + operationId: patchRole + description: Update an existing role + tags: + - Roles + requestBody: + $ref: "../requestBodies/PATCH/Role.yaml" + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Role.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user.yaml b/static/api-specs/nerm/paths/user.yaml new file mode 100644 index 000000000..ca61f0f11 --- /dev/null +++ b/static/api-specs/nerm/paths/user.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a new user + operationId: postUser + description: Create a new user + tags: + - Users + requestBody: + $ref: "../requestBodies/POST/User.yaml" + responses: + '200': + $ref: "../responses/User.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_manager.yaml b/static/api-specs/nerm/paths/user_manager.yaml new file mode 100644 index 000000000..d9f4de925 --- /dev/null +++ b/static/api-specs/nerm/paths/user_manager.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a new user-manager relationship + operationId: postUserManager + description: Create a new user-manager relationship + tags: + - User Managers + requestBody: + $ref: "../requestBodies/POST/UserManager.yaml" + responses: + '200': + $ref: "../responses/UserManager.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_managers.yaml b/static/api-specs/nerm/paths/user_managers.yaml new file mode 100644 index 000000000..6a30fddf6 --- /dev/null +++ b/static/api-specs/nerm/paths/user_managers.yaml @@ -0,0 +1,48 @@ +get: + summary: Get user-manager relationships + operationId: getUserManagers + description: This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters + tags: + - User Managers + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/user_id.yaml" + - $ref: "../parameters/query/manager_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/UserManagers_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new user-manager relationships + operationId: postUserManagers + description: Create multiple new user-manager relationships + tags: + - User Managers + requestBody: + $ref: "../requestBodies/POST/UserManagers.yaml" + responses: + '200': + $ref: "../responses/UserManagersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple user-manager relationships + operationId: patchUserManagers + description: Update multiple user-manager relationships + tags: + - User Managers + requestBody: + $ref: "../requestBodies/PATCH/UserManagers.yaml" + responses: + '200': + $ref: "../responses/UserManagersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_managers_id.yaml b/static/api-specs/nerm/paths/user_managers_id.yaml new file mode 100644 index 000000000..5e51e8ef0 --- /dev/null +++ b/static/api-specs/nerm/paths/user_managers_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find user-manager relationship by id + operationId: getUserManager + description: Info for a specific user-manager relationship + tags: + - User Managers + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserManager.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user-manager relationship by id + operationId: patchUserManager + description: Update a user-manager relationship by id + tags: + - User Managers + requestBody: + $ref: "../requestBodies/PATCH/UserManager.yaml" + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserManager.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_profile.yaml b/static/api-specs/nerm/paths/user_profile.yaml new file mode 100644 index 000000000..30544f37f --- /dev/null +++ b/static/api-specs/nerm/paths/user_profile.yaml @@ -0,0 +1,13 @@ +post: + summary: Create a user-profile contributor relationship + operationId: postUserProfile + description: Create a user-profile contributor relationship + tags: + - User Profiles + requestBody: + $ref: "../requestBodies/POST/UserProfile.yaml" + responses: + '200': + $ref: "../responses/UserProfile.yaml" + '405': + $ref: "../responses/InvalidInput.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_profile_id.yaml b/static/api-specs/nerm/paths/user_profile_id.yaml new file mode 100644 index 000000000..24112b92c --- /dev/null +++ b/static/api-specs/nerm/paths/user_profile_id.yaml @@ -0,0 +1,19 @@ +delete: + summary: Delete a user profile assignment + operationId: deleteUserProfile + description: Delete a user profile assignment + tags: + - User Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + description: "User profile was destroyed" + content: + application/json: + schema: + type: object + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_profiles.yaml b/static/api-specs/nerm/paths/user_profiles.yaml new file mode 100644 index 000000000..d8fade868 --- /dev/null +++ b/static/api-specs/nerm/paths/user_profiles.yaml @@ -0,0 +1,50 @@ +get: + summary: Get user-profile contributor relationships + operationId: getUserProfiles + description: Get user-profile contributor relationships + tags: + - User Profiles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/user_id.yaml" + - $ref: "../parameters/query/ne_attribute_id.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/relationship_type.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/UserProfiles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple user-profile contributor relationships + operationId: postUserProfiles + description: Create multiple user-profile contributor relationships + tags: + - User Profiles + requestBody: + $ref: "../requestBodies/POST/UserProfiles.yaml" + responses: + '200': + $ref: "../responses/UserProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple user-profile contributor relationships + operationId: patchUserProfiles + description: Update multiple user-profile contributor relationships + tags: + - User Profiles + requestBody: + $ref: "../requestBodies/PATCH/UserProfiles.yaml" + responses: + '200': + $ref: "../responses/UserProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_profiles_id.yaml b/static/api-specs/nerm/paths/user_profiles_id.yaml new file mode 100644 index 000000000..536d6a5c2 --- /dev/null +++ b/static/api-specs/nerm/paths/user_profiles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find user-profile contributor relationship by id + operationId: getUserProfile + description: Find user-profile contributor relationship by id + tags: + - User Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user-profile contributor relationship by id + operationId: patchUserProfile + description: Update a user-profile contributor relationship by id + tags: + - User Profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/UserProfile.yaml" + responses: + '200': + $ref: "../responses/UserProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_role.yaml b/static/api-specs/nerm/paths/user_role.yaml new file mode 100644 index 000000000..919152d3e --- /dev/null +++ b/static/api-specs/nerm/paths/user_role.yaml @@ -0,0 +1,15 @@ +post: + summary: Assign a new role to a user + operationId: postUserRole + description: Assign a new role to a user + tags: + - User Roles + requestBody: + $ref: "../requestBodies/POST/UserRole.yaml" + responses: + '200': + $ref: "../responses/UserRole.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_role_id.yaml b/static/api-specs/nerm/paths/user_role_id.yaml new file mode 100644 index 000000000..4b07b4376 --- /dev/null +++ b/static/api-specs/nerm/paths/user_role_id.yaml @@ -0,0 +1,19 @@ +delete: + summary: Delete a user role assignment + operationId: deleteUserRole + description: Delete a user role assignment + tags: + - User Roles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + description: "User role was destroyed" + content: + application/json: + schema: + type: object + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_roles.yaml b/static/api-specs/nerm/paths/user_roles.yaml new file mode 100644 index 000000000..9bf815b94 --- /dev/null +++ b/static/api-specs/nerm/paths/user_roles.yaml @@ -0,0 +1,48 @@ +get: + summary: Get user role pairings + operationId: getUserRoles + description: This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters + tags: + - User Roles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/user_id.yaml" + - $ref: "../parameters/query/role_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/UserRoles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new user role pairings + operationId: postUserRoles + description: Create multiple new user role pairings + tags: + - User Roles + requestBody: + $ref: "../requestBodies/POST/UserRoles.yaml" + responses: + '200': + $ref: "../responses/UserRolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple user role pairings + operationId: patchUserRoles + description: Update multiple user role pairings + tags: + - User Roles + requestBody: + $ref: "../requestBodies/PATCH/UserRoles.yaml" + responses: + '200': + $ref: "../responses/UserRolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/user_roles_id.yaml b/static/api-specs/nerm/paths/user_roles_id.yaml new file mode 100644 index 000000000..66849300a --- /dev/null +++ b/static/api-specs/nerm/paths/user_roles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find user role pairing by id + operationId: getUserRole + description: Info for a specific user role pairing + tags: + - User Roles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserRole.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user role pairing by id + operationId: patchUserRole + description: Update a user role pairing by id + tags: + - User Roles + requestBody: + $ref: "../requestBodies/PATCH/UserRole.yaml" + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserRole.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/users.yaml b/static/api-specs/nerm/paths/users.yaml new file mode 100644 index 000000000..1f1d3eef6 --- /dev/null +++ b/static/api-specs/nerm/paths/users.yaml @@ -0,0 +1,51 @@ +get: + summary: Get users + operationId: getUsers + description: This endpoint can retrieve users from Lifecycle or you can search for users using parameters + tags: + - Users + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/name.yaml" + - $ref: "../parameters/query/login.yaml" + - $ref: "../parameters/query/title.yaml" + - $ref: "../parameters/query/status.yaml" + - $ref: "../parameters/query/email.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Users_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new users + operationId: postUsers + description: Create multiple new users + tags: + - Users + requestBody: + $ref: "../requestBodies/POST/Users.yaml" + responses: + '200': + $ref: "../responses/UsersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple users + operationId: patchUsers + description: Update multiple users + tags: + - Users + requestBody: + $ref: "../requestBodies/PATCH/Users.yaml" + responses: + '200': + $ref: "../responses/UsersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/users_id.yaml b/static/api-specs/nerm/paths/users_id.yaml new file mode 100644 index 000000000..cdc61744f --- /dev/null +++ b/static/api-specs/nerm/paths/users_id.yaml @@ -0,0 +1,47 @@ +get: + summary: Find user by id + operationId: getUser + description: Info for a specific user + tags: + - Users + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/User.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user by id + operationId: patchUser + description: Update a user by id + tags: + - Users + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/User.yaml" + responses: + '200': + $ref: "../responses/User.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +delete: + summary: Delete a user + operationId: deleteUser + description: Delete a user + tags: + - Users + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/info.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/static/api-specs/nerm/paths/users_id_avatar.yaml b/static/api-specs/nerm/paths/users_id_avatar.yaml new file mode 100644 index 000000000..de361b3ce --- /dev/null +++ b/static/api-specs/nerm/paths/users_id_avatar.yaml @@ -0,0 +1,32 @@ +get: + summary: Retrieves the URL of the user avatar + operationId: getUserAvatar + description: Retrieves the URL of the user avatar + tags: + - Users + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new user avatar + operationId: postUserAvatar + description: Uploads a new user avatar + tags: + - Users + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/workflow_sessions.yaml b/static/api-specs/nerm/paths/workflow_sessions.yaml new file mode 100644 index 000000000..247671250 --- /dev/null +++ b/static/api-specs/nerm/paths/workflow_sessions.yaml @@ -0,0 +1,38 @@ +get: + summary: Get workflow sessions + operationId: getWorkflowSessions + description: Get workflow sessions + tags: + - Workflow Sessions + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/uid.yaml" + - $ref: "../parameters/query/workflow_id.yaml" + - $ref: "../parameters/query/requester_id.yaml" + - $ref: "../parameters/query/workflow_session_status.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/WorkflowSessions_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create a workflow session + operationId: postWorkflowSession + description: Create a workflow session + tags: + - Workflow Sessions + parameters: + - $ref: "../parameters/query/run.yaml" + requestBody: + $ref: "../requestBodies/POST/WorkflowSession.yaml" + responses: + '200': + $ref: "../responses/WorkflowSession.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/workflow_sessions_id.yaml b/static/api-specs/nerm/paths/workflow_sessions_id.yaml new file mode 100644 index 000000000..63d09e438 --- /dev/null +++ b/static/api-specs/nerm/paths/workflow_sessions_id.yaml @@ -0,0 +1,33 @@ +get: + summary: Find workflow session by id + operationId: getWorkflowSession + description: Find workflow session by id + tags: + - Workflow Sessions + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/WorkflowSession.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a workflow session by id + operationId: patchWorkflowSession + description: Update a workflow session by id + tags: + - Workflow Sessions + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/query/run.yaml" + requestBody: + $ref: "../requestBodies/PATCH/WorkflowSession.yaml" + responses: + '200': + $ref: "../responses/WorkflowSession.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml b/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml new file mode 100644 index 000000000..bb87c4da5 --- /dev/null +++ b/static/api-specs/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml @@ -0,0 +1,34 @@ +get: + summary: Retrieves the URL of an attachment attribute value from a workflow session + operationId: getWorkflowSessionUpload + description: Retrieves the URL of an attachment attribute value from a workflow session + tags: + - Workflow Sessions + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new attachment attribute value to a workflow session + operationId: postWorkflowSessionUpload + description: Uploads a new attachment attribute value to a workflow session + tags: + - Workflow Sessions + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/DELETE/Profiles.yaml b/static/api-specs/nerm/requestBodies/DELETE/Profiles.yaml new file mode 100644 index 000000000..e1d0d310e --- /dev/null +++ b/static/api-specs/nerm/requestBodies/DELETE/Profiles.yaml @@ -0,0 +1,14 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/AdvancedSearch.yaml b/static/api-specs/nerm/requestBodies/PATCH/AdvancedSearch.yaml new file mode 100644 index 000000000..9bad165b7 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/AdvancedSearch.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + $ref: "../../schemas/PATCH/AdvancedSearch.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/AttributeOption.yaml b/static/api-specs/nerm/requestBodies/PATCH/AttributeOption.yaml new file mode 100644 index 000000000..be9673bc9 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/AttributeOption.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + $ref: "../../schemas/PATCH/AttributeOption.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/AttributeOptions.yaml b/static/api-specs/nerm/requestBodies/PATCH/AttributeOptions.yaml new file mode 100644 index 000000000..16d430d3f --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/AttributeOptions.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: "../../schemas/PATCH/AttributeOptions.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/Profile.yaml b/static/api-specs/nerm/requestBodies/PATCH/Profile.yaml new file mode 100644 index 000000000..cf1ae5fd7 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/Profile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile: + type: object + $ref: "../../schemas/PATCH/Profile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/ProfileType.yaml b/static/api-specs/nerm/requestBodies/PATCH/ProfileType.yaml new file mode 100644 index 000000000..4bc6e6a80 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/ProfileType.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + $ref: "../../schemas/PATCH/ProfileType.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/Profiles.yaml b/static/api-specs/nerm/requestBodies/PATCH/Profiles.yaml new file mode 100644 index 000000000..f989864e7 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/Profiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: "../../schemas/PATCH/Profiles.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/Role.yaml b/static/api-specs/nerm/requestBodies/PATCH/Role.yaml new file mode 100644 index 000000000..147847751 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/Role.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role: + type: object + $ref: "../../schemas/PATCH/Role.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/RoleProfile.yaml b/static/api-specs/nerm/requestBodies/PATCH/RoleProfile.yaml new file mode 100644 index 000000000..a36f729a1 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/RoleProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + $ref: "../../schemas/PATCH/RoleProfile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/RoleProfiles.yaml b/static/api-specs/nerm/requestBodies/PATCH/RoleProfiles.yaml new file mode 100644 index 000000000..106e9dc42 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/RoleProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: "../../schemas/PATCH/RoleProfiles.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/Roles.yaml b/static/api-specs/nerm/requestBodies/PATCH/Roles.yaml new file mode 100644 index 000000000..de96b506d --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/Roles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + $ref: "../../schemas/PATCH/Role.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/User.yaml b/static/api-specs/nerm/requestBodies/PATCH/User.yaml new file mode 100644 index 000000000..f690eb4f6 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/User.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user: + type: object + $ref: "../../schemas/PATCH/User.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/UserManager.yaml b/static/api-specs/nerm/requestBodies/PATCH/UserManager.yaml new file mode 100644 index 000000000..a304f8624 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/UserManager.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + $ref: "../../schemas/PATCH/UserManager.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/UserManagers.yaml b/static/api-specs/nerm/requestBodies/PATCH/UserManagers.yaml new file mode 100644 index 000000000..7fcd19620 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/UserManagers.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + $ref: "../../schemas/PATCH/UserManagers.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/UserProfile.yaml b/static/api-specs/nerm/requestBodies/PATCH/UserProfile.yaml new file mode 100644 index 000000000..caa1ef0b5 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/UserProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + $ref: "../../schemas/PATCH/UserProfile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/UserProfiles.yaml b/static/api-specs/nerm/requestBodies/PATCH/UserProfiles.yaml new file mode 100644 index 000000000..213b358d3 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/UserProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: "../../schemas/PATCH/UserProfiles.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/UserRole.yaml b/static/api-specs/nerm/requestBodies/PATCH/UserRole.yaml new file mode 100644 index 000000000..0c5a2930a --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/UserRole.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_role: + type: object + $ref: "../../schemas/PATCH/UserRole.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/UserRoles.yaml b/static/api-specs/nerm/requestBodies/PATCH/UserRoles.yaml new file mode 100644 index 000000000..80f568380 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/UserRoles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: "../../schemas/PATCH/UserRoles.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/Users.yaml b/static/api-specs/nerm/requestBodies/PATCH/Users.yaml new file mode 100644 index 000000000..931b1da3c --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/Users.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + $ref: "../../schemas/PATCH/User.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/PATCH/WorkflowSession.yaml b/static/api-specs/nerm/requestBodies/PATCH/WorkflowSession.yaml new file mode 100644 index 000000000..8385507e6 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/PATCH/WorkflowSession.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + $ref: "../../schemas/PATCH/WorkflowSession.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/AdvancedSearch.yaml b/static/api-specs/nerm/requestBodies/POST/AdvancedSearch.yaml new file mode 100644 index 000000000..5971cfb03 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/AdvancedSearch.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + $ref: "../../schemas/POST/AdvancedSearch.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/AttributeOption.yaml b/static/api-specs/nerm/requestBodies/POST/AttributeOption.yaml new file mode 100644 index 000000000..da0ce7218 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/AttributeOption.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + $ref: "../../schemas/POST/AttributeOption.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/AttributeOptions.yaml b/static/api-specs/nerm/requestBodies/POST/AttributeOptions.yaml new file mode 100644 index 000000000..56e17fbf4 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/AttributeOptions.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: "../../schemas/POST/AttributeOption.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/File.yaml b/static/api-specs/nerm/requestBodies/POST/File.yaml new file mode 100644 index 000000000..2917e62e9 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/File.yaml @@ -0,0 +1,9 @@ +required: true +content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/Profile.yaml b/static/api-specs/nerm/requestBodies/POST/Profile.yaml new file mode 100644 index 000000000..163d76fd4 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/Profile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile: + type: object + $ref: "../../schemas/POST/Profile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/ProfileType.yaml b/static/api-specs/nerm/requestBodies/POST/ProfileType.yaml new file mode 100644 index 000000000..65473876a --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/ProfileType.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + $ref: "../../schemas/POST/ProfileType.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/Profiles.yaml b/static/api-specs/nerm/requestBodies/POST/Profiles.yaml new file mode 100644 index 000000000..a8da49029 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/Profiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: "../../schemas/POST/Profile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/Role.yaml b/static/api-specs/nerm/requestBodies/POST/Role.yaml new file mode 100644 index 000000000..483b957f6 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/Role.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role: + type: object + $ref: "../../schemas/POST/Role.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/RoleProfile.yaml b/static/api-specs/nerm/requestBodies/POST/RoleProfile.yaml new file mode 100644 index 000000000..37eb1b7a7 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/RoleProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + $ref: "../../schemas/POST/RoleProfile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/RoleProfiles.yaml b/static/api-specs/nerm/requestBodies/POST/RoleProfiles.yaml new file mode 100644 index 000000000..b19d2e4ac --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/RoleProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: "../../schemas/POST/RoleProfile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/Roles.yaml b/static/api-specs/nerm/requestBodies/POST/Roles.yaml new file mode 100644 index 000000000..c45a8a99c --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/Roles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + $ref: "../../schemas/POST/Role.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/User.yaml b/static/api-specs/nerm/requestBodies/POST/User.yaml new file mode 100644 index 000000000..500c3f540 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/User.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user: + type: object + $ref: "../../schemas/POST/User.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/UserManager.yaml b/static/api-specs/nerm/requestBodies/POST/UserManager.yaml new file mode 100644 index 000000000..bd75bf6bd --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/UserManager.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + $ref: "../../schemas/POST/UserManager.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/UserManagers.yaml b/static/api-specs/nerm/requestBodies/POST/UserManagers.yaml new file mode 100644 index 000000000..1759e3137 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/UserManagers.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + $ref: "../../schemas/POST/UserManager.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/UserProfile.yaml b/static/api-specs/nerm/requestBodies/POST/UserProfile.yaml new file mode 100644 index 000000000..400a4955c --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/UserProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + $ref: "../../schemas/POST/UserProfile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/UserProfiles.yaml b/static/api-specs/nerm/requestBodies/POST/UserProfiles.yaml new file mode 100644 index 000000000..fd37e3f55 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/UserProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: "../../schemas/POST/UserProfile.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/UserRole.yaml b/static/api-specs/nerm/requestBodies/POST/UserRole.yaml new file mode 100644 index 000000000..04972afe9 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/UserRole.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_role: + type: object + $ref: "../../schemas/POST/UserRole.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/UserRoles.yaml b/static/api-specs/nerm/requestBodies/POST/UserRoles.yaml new file mode 100644 index 000000000..a7248951d --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/UserRoles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: "../../schemas/POST/UserRole.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/Users.yaml b/static/api-specs/nerm/requestBodies/POST/Users.yaml new file mode 100644 index 000000000..8117813d3 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/Users.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + $ref: "../../schemas/POST/User.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/WorkflowSession.yaml b/static/api-specs/nerm/requestBodies/POST/WorkflowSession.yaml new file mode 100644 index 000000000..fc088c64a --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/WorkflowSession.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + $ref: "../../schemas/POST/WorkflowSession.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/responses/400.yaml b/static/api-specs/nerm/responses/400.yaml new file mode 100644 index 000000000..ce2b72ac5 --- /dev/null +++ b/static/api-specs/nerm/responses/400.yaml @@ -0,0 +1,7 @@ +description: Bad Request - unable to complete. +content: + application/json: + schema: + oneOf: + - $ref: "./InvalidJson.yaml" + - $ref: "./ValidationErrors.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/responses/404.yaml b/static/api-specs/nerm/responses/404.yaml new file mode 100644 index 000000000..e69de29bb diff --git a/static/api-specs/nerm/responses/500.yaml b/static/api-specs/nerm/responses/500.yaml new file mode 100644 index 000000000..82a933633 --- /dev/null +++ b/static/api-specs/nerm/responses/500.yaml @@ -0,0 +1,9 @@ +description: Internal Server Error - returned on unhandled exceptions. +content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: "Sorry something went wrong" \ No newline at end of file diff --git a/static/api-specs/nerm/responses/AdvancedSearch.yaml b/static/api-specs/nerm/responses/AdvancedSearch.yaml new file mode 100644 index 000000000..c119e8cba --- /dev/null +++ b/static/api-specs/nerm/responses/AdvancedSearch.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + $ref: '../schemas/GET/AdvancedSearch.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/AdvancedSearches.yaml b/static/api-specs/nerm/responses/AdvancedSearches.yaml new file mode 100644 index 000000000..8699cf793 --- /dev/null +++ b/static/api-specs/nerm/responses/AdvancedSearches.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: array + items: + $ref: '../schemas/GET/AdvancedSearch.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Attribute.yaml b/static/api-specs/nerm/responses/Attribute.yaml new file mode 100644 index 000000000..9d6e9f7fa --- /dev/null +++ b/static/api-specs/nerm/responses/Attribute.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute: + type: object + $ref: '../schemas/GET/Attribute.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/AttributeOption.yaml b/static/api-specs/nerm/responses/AttributeOption.yaml new file mode 100644 index 000000000..736f456c7 --- /dev/null +++ b/static/api-specs/nerm/responses/AttributeOption.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + $ref: '../schemas/GET/AttributeOption.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/AttributeOptions.yaml b/static/api-specs/nerm/responses/AttributeOptions.yaml new file mode 100644 index 000000000..0ebb6550a --- /dev/null +++ b/static/api-specs/nerm/responses/AttributeOptions.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: '../schemas/GET/AttributeOption.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/AttributeOptionsJob.yaml b/static/api-specs/nerm/responses/AttributeOptionsJob.yaml new file mode 100644 index 000000000..0b805eb14 --- /dev/null +++ b/static/api-specs/nerm/responses/AttributeOptionsJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/AttributeOptions.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/AttributeOptions_Meta.yaml b/static/api-specs/nerm/responses/AttributeOptions_Meta.yaml new file mode 100644 index 000000000..15fe958f2 --- /dev/null +++ b/static/api-specs/nerm/responses/AttributeOptions_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: '../schemas/GET/AttributeOption.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Attributes.yaml b/static/api-specs/nerm/responses/Attributes.yaml new file mode 100644 index 000000000..ca4664e2f --- /dev/null +++ b/static/api-specs/nerm/responses/Attributes.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attributes: + type: array + items: + $ref: '../schemas/GET/Attribute.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Attributes_Meta.yaml b/static/api-specs/nerm/responses/Attributes_Meta.yaml new file mode 100644 index 000000000..6539afb44 --- /dev/null +++ b/static/api-specs/nerm/responses/Attributes_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attributes: + type: array + items: + $ref: '../schemas/GET/Attribute.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/DeleteConfirmation.yaml b/static/api-specs/nerm/responses/DeleteConfirmation.yaml new file mode 100644 index 000000000..e4e29e3de --- /dev/null +++ b/static/api-specs/nerm/responses/DeleteConfirmation.yaml @@ -0,0 +1,9 @@ +description: Confirmation of a deleted object +content: + application/json: + schema: + type: object + properties: + info: + type: string + default: "The option '{Option Value}' has been deleted" diff --git a/static/api-specs/nerm/responses/IdentityProofingResults.yaml b/static/api-specs/nerm/responses/IdentityProofingResults.yaml new file mode 100644 index 000000000..807d6e0bb --- /dev/null +++ b/static/api-specs/nerm/responses/IdentityProofingResults.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + identity_proofing_results: + type: array + items: + $ref: '../schemas/GET/IdentityProofingResult.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Info.yaml b/static/api-specs/nerm/responses/Info.yaml new file mode 100644 index 000000000..183e2bb63 --- /dev/null +++ b/static/api-specs/nerm/responses/Info.yaml @@ -0,0 +1,9 @@ +description: "Info about the operation" +content: + application/json: + schema: + type: object + properties: + info: + description: A message confirming the operation + example: object deleted \ No newline at end of file diff --git a/static/api-specs/nerm/responses/InvalidInput.yaml b/static/api-specs/nerm/responses/InvalidInput.yaml new file mode 100644 index 000000000..a3a597ae6 --- /dev/null +++ b/static/api-specs/nerm/responses/InvalidInput.yaml @@ -0,0 +1 @@ +description: Invalid input \ No newline at end of file diff --git a/static/api-specs/nerm/responses/InvalidJson.yaml b/static/api-specs/nerm/responses/InvalidJson.yaml new file mode 100644 index 000000000..8198454da --- /dev/null +++ b/static/api-specs/nerm/responses/InvalidJson.yaml @@ -0,0 +1,4 @@ +type: object +properties: + error: + example: "Invalid JSON syntax. Please check your syntax and try again." \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Job.yaml b/static/api-specs/nerm/responses/Job.yaml new file mode 100644 index 000000000..88fbfa731 --- /dev/null +++ b/static/api-specs/nerm/responses/Job.yaml @@ -0,0 +1,32 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + uid: + type: string + format: uuid + status: + type: string + # enum: ["complete", "queued"] + example: "complete" + job_type: + type: string + example: import + job_data: + type: array + items: + type: object + properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + errors: + type: array + items: + type: string + example: Validation error for record in job \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Profile.yaml b/static/api-specs/nerm/responses/Profile.yaml new file mode 100644 index 000000000..23293c56e --- /dev/null +++ b/static/api-specs/nerm/responses/Profile.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile: + type: object + $ref: '../schemas/GET/Profile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/ProfileType.yaml b/static/api-specs/nerm/responses/ProfileType.yaml new file mode 100644 index 000000000..cf5e0e1e1 --- /dev/null +++ b/static/api-specs/nerm/responses/ProfileType.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + $ref: '../schemas/GET/ProfileType.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/ProfileTypes.yaml b/static/api-specs/nerm/responses/ProfileTypes.yaml new file mode 100644 index 000000000..ec9926b39 --- /dev/null +++ b/static/api-specs/nerm/responses/ProfileTypes.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile_types: + type: array + items: + $ref: '../schemas/GET/ProfileType.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/ProfileTypes_Meta.yaml b/static/api-specs/nerm/responses/ProfileTypes_Meta.yaml new file mode 100644 index 000000000..dc1a1f29a --- /dev/null +++ b/static/api-specs/nerm/responses/ProfileTypes_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile_types: + type: array + items: + $ref: '../schemas/GET/ProfileType.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Profiles.yaml b/static/api-specs/nerm/responses/Profiles.yaml new file mode 100644 index 000000000..bd7b9f840 --- /dev/null +++ b/static/api-specs/nerm/responses/Profiles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: '../schemas/GET/Profile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/ProfilesJob.yaml b/static/api-specs/nerm/responses/ProfilesJob.yaml new file mode 100644 index 000000000..0360931a2 --- /dev/null +++ b/static/api-specs/nerm/responses/ProfilesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/Profiles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Profiles_Meta.yaml b/static/api-specs/nerm/responses/Profiles_Meta.yaml new file mode 100644 index 000000000..799402f27 --- /dev/null +++ b/static/api-specs/nerm/responses/Profiles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: '../schemas/GET/Profile.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RiskLevel.yaml b/static/api-specs/nerm/responses/RiskLevel.yaml new file mode 100644 index 000000000..0dcbce538 --- /dev/null +++ b/static/api-specs/nerm/responses/RiskLevel.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_level: + type: object + $ref: '../schemas/GET/RiskLevel.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RiskLevels_Meta.yaml b/static/api-specs/nerm/responses/RiskLevels_Meta.yaml new file mode 100644 index 000000000..4e91089b1 --- /dev/null +++ b/static/api-specs/nerm/responses/RiskLevels_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_levels: + type: array + items: + $ref: '../schemas/GET/RiskLevel.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RiskScore.yaml b/static/api-specs/nerm/responses/RiskScore.yaml new file mode 100644 index 000000000..81898582c --- /dev/null +++ b/static/api-specs/nerm/responses/RiskScore.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_score: + type: object + $ref: '../schemas/GET/RiskScore.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RiskScores.yaml b/static/api-specs/nerm/responses/RiskScores.yaml new file mode 100644 index 000000000..9b422a1e1 --- /dev/null +++ b/static/api-specs/nerm/responses/RiskScores.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_scores: + type: array + items: + $ref: '../schemas/GET/RiskScore.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Role.yaml b/static/api-specs/nerm/responses/Role.yaml new file mode 100644 index 000000000..e60086103 --- /dev/null +++ b/static/api-specs/nerm/responses/Role.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role: + type: object + $ref: '../schemas/GET/Role.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RoleProfile.yaml b/static/api-specs/nerm/responses/RoleProfile.yaml new file mode 100644 index 000000000..791126d08 --- /dev/null +++ b/static/api-specs/nerm/responses/RoleProfile.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + $ref: '../schemas/GET/RoleProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RoleProfiles.yaml b/static/api-specs/nerm/responses/RoleProfiles.yaml new file mode 100644 index 000000000..15e2487b7 --- /dev/null +++ b/static/api-specs/nerm/responses/RoleProfiles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: '../schemas/GET/RoleProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RoleProfilesJob.yaml b/static/api-specs/nerm/responses/RoleProfilesJob.yaml new file mode 100644 index 000000000..d59230dfa --- /dev/null +++ b/static/api-specs/nerm/responses/RoleProfilesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/RoleProfiles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RoleProfiles_Meta.yaml b/static/api-specs/nerm/responses/RoleProfiles_Meta.yaml new file mode 100644 index 000000000..b534baa8f --- /dev/null +++ b/static/api-specs/nerm/responses/RoleProfiles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: '../schemas/GET/RoleProfile.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/RolesJob.yaml b/static/api-specs/nerm/responses/RolesJob.yaml new file mode 100644 index 000000000..13c17febe --- /dev/null +++ b/static/api-specs/nerm/responses/RolesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/Roles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Roles_Meta.yaml b/static/api-specs/nerm/responses/Roles_Meta.yaml new file mode 100644 index 000000000..15ebcadf1 --- /dev/null +++ b/static/api-specs/nerm/responses/Roles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + $ref: '../schemas/GET/Role.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Url.yaml b/static/api-specs/nerm/responses/Url.yaml new file mode 100644 index 000000000..327c8c5ee --- /dev/null +++ b/static/api-specs/nerm/responses/Url.yaml @@ -0,0 +1,5 @@ +description: Expected response to a valid request +content: + application/json: + schema: + $ref: "../schemas/Url.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/responses/User.yaml b/static/api-specs/nerm/responses/User.yaml new file mode 100644 index 000000000..de40badca --- /dev/null +++ b/static/api-specs/nerm/responses/User.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user: + type: object + $ref: '../schemas/GET/User.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserManager.yaml b/static/api-specs/nerm/responses/UserManager.yaml new file mode 100644 index 000000000..d21c355b6 --- /dev/null +++ b/static/api-specs/nerm/responses/UserManager.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + $ref: '../schemas/GET/UserManager.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserManagersJob.yaml b/static/api-specs/nerm/responses/UserManagersJob.yaml new file mode 100644 index 000000000..48f7552fa --- /dev/null +++ b/static/api-specs/nerm/responses/UserManagersJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/Job.yaml' + - $ref: '../schemas/GET/UserManagers.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserManagers_Meta.yaml b/static/api-specs/nerm/responses/UserManagers_Meta.yaml new file mode 100644 index 000000000..85bc9d1f4 --- /dev/null +++ b/static/api-specs/nerm/responses/UserManagers_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + $ref: '../schemas/GET/UserManager.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserProfile.yaml b/static/api-specs/nerm/responses/UserProfile.yaml new file mode 100644 index 000000000..3d243f5a5 --- /dev/null +++ b/static/api-specs/nerm/responses/UserProfile.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + $ref: '../schemas/GET/UserProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserProfiles.yaml b/static/api-specs/nerm/responses/UserProfiles.yaml new file mode 100644 index 000000000..2cf068dd3 --- /dev/null +++ b/static/api-specs/nerm/responses/UserProfiles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: '../schemas/GET/UserProfile.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserProfilesJob.yaml b/static/api-specs/nerm/responses/UserProfilesJob.yaml new file mode 100644 index 000000000..ebe071efe --- /dev/null +++ b/static/api-specs/nerm/responses/UserProfilesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/UserProfiles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserProfiles_Meta.yaml b/static/api-specs/nerm/responses/UserProfiles_Meta.yaml new file mode 100644 index 000000000..76efc87b8 --- /dev/null +++ b/static/api-specs/nerm/responses/UserProfiles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: '../schemas/GET/UserProfile.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserRole.yaml b/static/api-specs/nerm/responses/UserRole.yaml new file mode 100644 index 000000000..0b73dbd36 --- /dev/null +++ b/static/api-specs/nerm/responses/UserRole.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_role: + type: object + $ref: '../schemas/GET/UserRole.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserRoles.yaml b/static/api-specs/nerm/responses/UserRoles.yaml new file mode 100644 index 000000000..62c09b3a2 --- /dev/null +++ b/static/api-specs/nerm/responses/UserRoles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: '../schemas/GET/UserRole.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserRolesJob.yaml b/static/api-specs/nerm/responses/UserRolesJob.yaml new file mode 100644 index 000000000..e3f732b09 --- /dev/null +++ b/static/api-specs/nerm/responses/UserRolesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/UserRoles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UserRoles_Meta.yaml b/static/api-specs/nerm/responses/UserRoles_Meta.yaml new file mode 100644 index 000000000..8b8bce14d --- /dev/null +++ b/static/api-specs/nerm/responses/UserRoles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: '../schemas/GET/UserRole.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/UsersJob.yaml b/static/api-specs/nerm/responses/UsersJob.yaml new file mode 100644 index 000000000..18d7e2683 --- /dev/null +++ b/static/api-specs/nerm/responses/UsersJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/Users.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/Users_Meta.yaml b/static/api-specs/nerm/responses/Users_Meta.yaml new file mode 100644 index 000000000..37a691384 --- /dev/null +++ b/static/api-specs/nerm/responses/Users_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + $ref: '../schemas/GET/User.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/ValidationErrors.yaml b/static/api-specs/nerm/responses/ValidationErrors.yaml new file mode 100644 index 000000000..719b4f145 --- /dev/null +++ b/static/api-specs/nerm/responses/ValidationErrors.yaml @@ -0,0 +1,7 @@ +type: object +properties: + error: + example: "The failed to create/update" + errors: + example: + attribute: "can't be blank" \ No newline at end of file diff --git a/static/api-specs/nerm/responses/WorkflowSession.yaml b/static/api-specs/nerm/responses/WorkflowSession.yaml new file mode 100644 index 000000000..bbe4d907d --- /dev/null +++ b/static/api-specs/nerm/responses/WorkflowSession.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + $ref: '../schemas/GET/WorkflowSession.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/WorkflowSessions.yaml b/static/api-specs/nerm/responses/WorkflowSessions.yaml new file mode 100644 index 000000000..1e5386201 --- /dev/null +++ b/static/api-specs/nerm/responses/WorkflowSessions.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_sessions: + type: array + items: + $ref: '../schemas/GET/WorkflowSession.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/WorkflowSessions_Meta.yaml b/static/api-specs/nerm/responses/WorkflowSessions_Meta.yaml new file mode 100644 index 000000000..69bece6ac --- /dev/null +++ b/static/api-specs/nerm/responses/WorkflowSessions_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_sessions: + type: array + items: + $ref: '../schemas/GET/WorkflowSession.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/_index.yaml b/static/api-specs/nerm/responses/_index.yaml new file mode 100644 index 000000000..0fae492d4 --- /dev/null +++ b/static/api-specs/nerm/responses/_index.yaml @@ -0,0 +1,63 @@ +# 200 +User: + $ref: './User.yaml' +Users: + $ref: './Users.yaml' +UserManager: + $ref: './UserManager.yaml' +UserManagers: + $ref: './UserManagers.yaml' +UserRole: + $ref: './UserRole.yaml' +UserRoles: + $ref: './UserRoles.yaml' +Attribute: + $ref: './Attribute.yaml' +Attributes: + $ref: './Attributes.yaml' +AttributeOption: + $ref: './AttributeOption.yaml' +AttributeOptions: + $ref: './AttributeOptions.yaml' +ProfileType: + $ref: './ProfileType.yaml' +ProfileTypes: + $ref: './ProfileTypes.yaml' +Profile: + $ref: './Profile.yaml' +Profiles: + $ref: './Profiles.yaml' +RiskScore: + $ref: './RiskScore.yaml' +RiskScores: + $ref: './RiskScores.yaml' +RiskLevel: + $ref: './RiskLevel.yaml' +RiskLevels: + $ref: './RiskLevels.yaml' +UserProfile: + $ref: './UserProfile.yaml' +UserProfiles: + $ref: './UserProfiles.yaml' +RoleProfile: + $ref: './RoleProfile.yaml' +RoleProfiles: + $ref: './RoleProfiles.yaml' +WorkflowSession: + $ref: './WorkflowSession.yaml' +WorkflowSessions: + $ref: './WorkflowSessions.yaml' +IdentityProofingResults: + $ref: './IdentityProofingResults.yaml' +AdvancedSearch: + $ref: './AdvancedSearch.yaml' +AdvancedSearches: + $ref: './AdvancedSearches.yaml' +# Special +Url: + $ref: './Url.yaml' +DeleteConfirmation: + $ref: './DeleteConfirmation.yaml' +# 405 +InvalidInput: + $ref: './InvalidInput.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml b/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml new file mode 100644 index 000000000..c2b76594c --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/AdvancedSearch.yaml @@ -0,0 +1,39 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + label: + description: the label + type: string + example: mylabel + condition_rules_attributes: + description: The condition rules attributes + type: array + items: + anyOf: + - $ref: "./ProfileTypeRule.yaml" + - $ref: "./ProfileStatusRule.yaml" + - $ref: "./ProfileAttributeRuleString.yaml" + - $ref: "./ProfileAttributeRuleDate.yaml" + - $ref: "./ProfileAttributeRuleId.yaml" + - $ref: "./RiskRule.yaml" + example: + - type: ProfileTypeRule + comparison_operator: == + value: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - type: ProfileStatusRule + id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: == + value: Active diff --git a/static/api-specs/nerm/schemas/GET/Attribute.yaml b/static/api-specs/nerm/schemas/GET/Attribute.yaml new file mode 100644 index 000000000..3747d11aa --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/Attribute.yaml @@ -0,0 +1,120 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + label: + description: The label + type: string + example: my_attribute + description: + description: The description + type: string + example: This is my attribute + tool_tip: + description: The tool tip + type: string + example: my attribute + crypt: + description: Should this be encrypted? + type: boolean + example: true + archived: + description: Is this attribute archived? + type: boolean + example: false + archived_on: + description: When was this attribute archved + type: string + format: date-time + readOnly: true + example: 2023-05-01T09:12:28Z + created_at: + description: The created_at time + type: string + format: date-time + readOnly: true + example: 2023-05-01T09:12:28Z + updated_at: + description: The updated_at time + type: string + format: date-time + readOnly: true + example: 2023-05-01T09:12:28Z + date_format: + description: The format of the date + type: string + enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd] + example: mm/dd/yyyy + selectable_status: + description: The selectable_status + type: string + example: Active + risk_score_setting: + description: The risk score setting + type: string + example: standard + risk_type: + description: The risk type + type: string + example: inherited + ownership_driver: + description: The ownership_driver + type: boolean + example: true + allow_multiple_selections: + description: allow multiple selections + type: boolean + example: false + filtered_by_ne_attribute: + description: Should this attribute be filtered_by_ne_attribute + type: boolean + example: false + filtering_ne_attribute_id: + description: The ne_attribute_id to use for filtering + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_filter_id: + description: The ne_attribute_id to filter by + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + reverse_association_attribute_id: + description: The reverse association ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: The profile_type_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + legacy_id: + description: The legacy ID + type: integer + format: int32 + example: 123 + tmp_created_at: + description: (Deprecated) The temporary created_at field + type: string + format: date-time + readOnly: true + example: 2023-05-01T09:12:28Z + tmp_updated_at: + description: (Deprecated) The temporary updated_at field + type: string + format: date-time + readOnly: true + example: 2023-05-01T09:12:28Z + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/AttributeOption.yaml b/static/api-specs/nerm/schemas/GET/AttributeOption.yaml new file mode 100644 index 000000000..8ea403c87 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/AttributeOption.yaml @@ -0,0 +1,24 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: the ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + option: + description: the option + type: string + example: myoption \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml b/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml new file mode 100644 index 000000000..e04935c79 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/AttributeOptions.yaml @@ -0,0 +1,15 @@ +type: object +properties: + ne_attribute_options: + type: array + items: + $ref: '../GET/AttributeOption.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + option: myoption1 + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9d511 + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9d511 + ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9d511 + option: myoption2 diff --git a/static/api-specs/nerm/schemas/GET/IdentityProofingResult.yaml b/static/api-specs/nerm/schemas/GET/IdentityProofingResult.yaml new file mode 100644 index 000000000..04e2db4eb --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/IdentityProofingResult.yaml @@ -0,0 +1,50 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + identity_proofing_action_id: + description: The identity_proofing_action_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + workflow_session_id: + description: the workflow_session_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: the profile_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + proofing_workflow: + description: the proofing workflow id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + result: + description: the result of the identity proofing + type: string + enum: [pending, pass, fail] + example: pass + proofing_attributes: + description: Any additional attributes associated with the proofing + type: object + additionalProperties: + type: string + example: + result: approve + created_at: + description: The created at time + type: string + format: date-time + example: 2023-05-01T09:12:28Z + updated_at: + description: The updated at time + type: string + format: date-time + example: 2023-05-01T09:12:28Z \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Profile.yaml b/static/api-specs/nerm/schemas/GET/Profile.yaml new file mode 100644 index 000000000..16bbfd95d --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/Profile.yaml @@ -0,0 +1,56 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: + description: the name + type: string + example: my profile + profile_type_id: + description: The profile type id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + status: + description: the status + type: string + enum: [Active, Inactive, On Leave, Terminated] + example: Active + id_proofing_status: + description: the id profing status + type: string + enum: [pending, pass, fail] + example: pending + created_at: + description: the created at time + type: string + format: date-time + example: 2023-05-01T09:12:28Z + updated_at: + description: the updated at time + type: string + format: date-time + example: 2023-05-01T09:12:28Z + attributes: + description: the attributes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml new file mode 100644 index 000000000..928d90a3a --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleDate.yaml @@ -0,0 +1,66 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition object type + type: string + required: true + enum: [DateAttribute] + example: DateAttribute + condition_object_id: + description: The condition object id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + secondary_attribute_type: + description: The secondary_attribute_type + type: string + enum: [DateAttribute] + example: DateAttribute + secondary_attribute_id: + description: The secondary_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator to use for comparison + type: string + enum: ['>', '<', 'after', 'before'] + example: < + value: + description: The value to use for comparison + type: string + required: true + enum: ['Today', ''] + example: Today + secondary_value: + description: The secondary value + type: string + enum: ['after', 'before'] + example: after + tertiary_value: + description: the tertiary_value + type: string + example: 30 + + + + diff --git a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml new file mode 100644 index 000000000..58c70b7cd --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleId.yaml @@ -0,0 +1,45 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition_object_type + type: string + required: true + enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] + example: OwnerSearchAttribute + condition_object_id: + description: The condition_object_id + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The comparison_operator + type: string + required: true + enum: ['include?', 'exclude?'] + example: include? + value: + description: The value + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e diff --git a/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml new file mode 100644 index 000000000..b2ca6df21 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileAttributeRuleString.yaml @@ -0,0 +1,44 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition_object_type + type: string + required: true + enum: [TextFieldAttribute, TextAreaAttribute] + example: TextAreaAttribute + condition_object_id: + description: The condition_object_id + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator to use for comparison + type: string + required: true + enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] + example: == + value: + description: The value + type: string + required: true + example: Some value diff --git a/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml b/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml new file mode 100644 index 000000000..acce840de --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileStatusRule.yaml @@ -0,0 +1,32 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileStatusRule] + example: ProfileStatusRule + comparison_operator: + description: The comparison operator + type: string + enum: ['==', '!='] + example: == + value: + description: The value + type: string + enum: [Active, Inactive, Leave of absence, Terminated] + example: Active + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/ProfileType.yaml b/static/api-specs/nerm/schemas/GET/ProfileType.yaml new file mode 100644 index 000000000..b5b09a1d3 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileType.yaml @@ -0,0 +1,107 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: + description: the name + type: string + example: my profile type + bypass_dup_protection: + description: bypass duplicate protection? + type: boolean + example: false + archived: + description: is this profile type archived? + type: boolean + example: false + permitted_role_ids: + description: permitted role_ids for this profile_type + type: array + items: + type: string + format: uuid + example: + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df92 + profile_type_dup_attributes: + description: The profile type duplicate attributes + type: array + items: + type: object + properties: + id: + description: the id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: the profile type id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: the ne attribute id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f + profile_type_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g + ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h + profile_type_namings: + description: the profile type namings + type: array + items: + type: object + properties: + id: + description: the id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: the profile type id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: the ne attribute id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + order: + description: the order + type: integer + format: int32 + minimum: 0 + example: 0 + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f + profile_type_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g + ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h + order: 0 diff --git a/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml b/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml new file mode 100644 index 000000000..901ee3c40 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileTypeRule.yaml @@ -0,0 +1,32 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uuid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileTypeRule] + example: ProfileTypeRule + comparison_operator: + description: The comparison operator + type: string + enum: ['==', '!='] + example: == + value: + description: The value + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Profiles.yaml b/static/api-specs/nerm/schemas/GET/Profiles.yaml new file mode 100644 index 000000000..664a4e7c4 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/Profiles.yaml @@ -0,0 +1,22 @@ +type: object +properties: + profiles: + type: array + items: + $ref: '../GET/Profile.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: my profile + profile_type_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + status: Active + id_proofing_status: pending + created_at: 2023-05-01T09:12:28Z + updated_at: 2023-05-01T09:12:28Z + attributes: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RiskLevel.yaml b/static/api-specs/nerm/schemas/GET/RiskLevel.yaml new file mode 100644 index 000000000..37717c185 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/RiskLevel.yaml @@ -0,0 +1,31 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + label: + description: The label + type: string + example: my_risk_level + points: + description: The risk points + type: number + format: decimal + multipleOf: 0.01 + example: 0.5 + order: + description: The order of this risk level + type: integer + format: int32 + minimum: 0 + example: 0 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RiskRule.yaml b/static/api-specs/nerm/schemas/GET/RiskRule.yaml new file mode 100644 index 000000000..c5be879f7 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/RiskRule.yaml @@ -0,0 +1,39 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [RiskRule] + example: RiskRule + comparison_operator: + description: The operator to use for comparison + type: string + enum: ['==', '>', '<'] + example: == + value: + description: Id of the Risk Level being compared against + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + secondary_value: + description: The secondary value + type: string + required: true + enum: [OverallRisk] + example: OverallRisk \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RiskScore.yaml b/static/api-specs/nerm/schemas/GET/RiskScore.yaml new file mode 100644 index 000000000..cd2fb777f --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/RiskScore.yaml @@ -0,0 +1,58 @@ +type: object +properties: + id: + description: id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + object_id: + description: the object id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + object_type: + description: the object type + type: string + enum: [Profile, WorkflowSession] + example: Profile + overall_score: + description: Overall score + type: number + format: decimal + multipleOf: 0.01 + example: 0.2 + overall_risk_level_id: + description: the overall risk level id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + impact_score: + description: the impact score + type: number + format: decimal + multipleOf: 0.01 + example: 0.4 + impact_risk_level_id: + description: the impact risk level id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + probability_score: + description: the probability_score + type: number + format: decimal + multipleOf: 0.01 + example: 0.5 + probability_risk_level_id: + description: The probability risk level id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e diff --git a/static/api-specs/nerm/schemas/GET/Role.yaml b/static/api-specs/nerm/schemas/GET/Role.yaml new file mode 100644 index 000000000..335db26df --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/Role.yaml @@ -0,0 +1,26 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: "sponsors_role" + name: + description: The name + type: string + example: "Sponsors" + groups: + description: the groups + type: array + items: + type: string + example: + - "ad_group_name" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RoleProfile.yaml b/static/api-specs/nerm/schemas/GET/RoleProfile.yaml new file mode 100644 index 000000000..79fc99bec --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/RoleProfile.yaml @@ -0,0 +1,26 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: + description: The role id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: The profile id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml b/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml new file mode 100644 index 000000000..b73bc15e2 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/RoleProfiles.yaml @@ -0,0 +1,11 @@ +type: object +properties: + role_profiles: + type: array + items: + $ref: '../GET/RoleProfile.yaml' + example: + id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e diff --git a/static/api-specs/nerm/schemas/GET/Roles.yaml b/static/api-specs/nerm/schemas/GET/Roles.yaml new file mode 100644 index 000000000..e2fb1d687 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/Roles.yaml @@ -0,0 +1,13 @@ +type: object +properties: + roles: + description: the list of roles + type: array + items: + $ref: '../GET/Role.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: "sponsors_role" + name: "Sponsors" + groups: + - "ad_group_name" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/User.yaml b/static/api-specs/nerm/schemas/GET/User.yaml new file mode 100644 index 000000000..59e9c2716 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/User.yaml @@ -0,0 +1,59 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readonly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readonly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: + description: The name + type: string + example: bob + email: + description: The email + type: string + format: email + example: example@sailpoint.com + type: + description: The type + type: string + enum: [NeprofileUser, NeaccessUser] + default: NeprofileUser + example: NeprofileUser + title: + description: The title + type: string + example: mytitle + status: + description: The status + type: string + enum: [Active, Disabled] + example: Active + login: + description: The login + type: string + example: bob + last_login: + description: The last login time + type: string + format: date-time + readOnly: true + example: "2023-05-01T09:12:28Z" + cookies_accepted_at: + description: The time the cookies were accepted at + type: string + format: date-time + readOnly: true + example: "2023-05-01T09:12:28Z" + preferred_language: + description: The preferred language + type: string + example: en-US \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserManager.yaml b/static/api-specs/nerm/schemas/GET/UserManager.yaml new file mode 100644 index 000000000..1704df944 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/UserManager.yaml @@ -0,0 +1,25 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: + description: the user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + manager_id: + description: the manager id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e diff --git a/static/api-specs/nerm/schemas/GET/UserManagers.yaml b/static/api-specs/nerm/schemas/GET/UserManagers.yaml new file mode 100644 index 000000000..58762443c --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/UserManagers.yaml @@ -0,0 +1,11 @@ +type: object +properties: + user_managers: + type: array + items: + $ref: '../GET/UserManager.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9g + user_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9h + manager_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9l \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserProfile.yaml b/static/api-specs/nerm/schemas/GET/UserProfile.yaml new file mode 100644 index 000000000..edaeac0b5 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/UserProfile.yaml @@ -0,0 +1,35 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: + description: The user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: The profile_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + relationship_type: + description: the relationship_type + type: string + enum: [owner, contributor] + example: owner \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserProfiles.yaml b/static/api-specs/nerm/schemas/GET/UserProfiles.yaml new file mode 100644 index 000000000..7b3b9aa09 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/UserProfiles.yaml @@ -0,0 +1,18 @@ +type: object +properties: + user_profiles: + type: array + items: + $ref: '../GET/UserProfile.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + relationship_type: owner + + + + + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserRole.yaml b/static/api-specs/nerm/schemas/GET/UserRole.yaml new file mode 100644 index 000000000..4328f93f4 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/UserRole.yaml @@ -0,0 +1,26 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: + description: the user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: + description: the role id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/UserRoles.yaml b/static/api-specs/nerm/schemas/GET/UserRoles.yaml new file mode 100644 index 000000000..bc09ca4d7 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/UserRoles.yaml @@ -0,0 +1,11 @@ +type: object +properties: + user_roles: + type: array + items: + $ref: '../GET/UserRole.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9a + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b + user_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9c + role_id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/Users.yaml b/static/api-specs/nerm/schemas/GET/Users.yaml new file mode 100644 index 000000000..0fdebb499 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/Users.yaml @@ -0,0 +1,18 @@ +type: object +properties: + users: + type: array + items: + $ref: '../GET/User.yaml' + example: + - id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: bob + email: example@sailpoint.com + type: NeprofileUser + title: mytitle + status: Active + login: bob + last_login: "2023-05-01T09:12:28Z" + cookies_accepted_at: "2023-05-01T09:12:28Z" + preferred_language: en-US \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml b/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml new file mode 100644 index 000000000..27498f0e8 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/WorkflowSession.yaml @@ -0,0 +1,61 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + workflow_id: + description: The workflow id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + requester_id: + description: the requester id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + requester_type: + description: The requester type + type: string + enum: [User, NeprofileUser, NeaccessUser] + example: User + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + example: + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t + status: + description: The status + type: string + enum: [api_request_sent, approved, assigned, attempting_to_start_workflow, AUTH-STATUS1, AUTH-STATUS2, AUTH-STATUS3, AUTH-STATUS4, AUTH-STATUS5, AUTH-STATUS6, AUTH-STATUS7, AUTH-STATUS8, AUTH-STATUS9, auto_assigned, batch_completed, checking_for_duplicates, closed, completed, courion_add, courion_extend, courion_terminate, courion_update, duplicates_resolved, failed, fulfilled, invitation_sent, ldap_provided, new, non_employee_created, non_employee_updated, notified, pending_approval, pending_assignment, pending_courion_add, pending_courion_extend, pending_courion_terminate, pending_courion_update, pending_creation, pending_fulfillment, pending_ldap, pending_notification, pending_profile_select, pending_request, pending_review, pending_status_change, pending_stored_procedure, pending_trigger, pending_update, processing, profile_check_complete, profiles_selected, rejected, requested, reviewed, soap_request_sent, started_workflow, status_changed, stored_procedure, un_assigned, waiting_on_workflow, workflow_changed] + example: completed + attributes: + description: The attributes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/Job.yaml b/static/api-specs/nerm/schemas/Job.yaml new file mode 100644 index 000000000..3cbcf3636 --- /dev/null +++ b/static/api-specs/nerm/schemas/Job.yaml @@ -0,0 +1,23 @@ +type: object +properties: + info: + description: info about the job + type: string + example: "job has started" + job_status: + description: the status of the job + type: object + properties: + job_id: + description: the job id + type: string + example: "3ce88e47ad6dba2ddf349d21" + status: + description: the status + type: string + example: "queued" + status: + description: the status + type: integer + format: int32 + example: 200 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/Metadata.yaml b/static/api-specs/nerm/schemas/Metadata.yaml new file mode 100644 index 000000000..8d0b24c62 --- /dev/null +++ b/static/api-specs/nerm/schemas/Metadata.yaml @@ -0,0 +1,25 @@ +type: object +properties: + limit: + description: The limit + type: integer + format: int32 + example: 50 + offset: + description: The offset + type: integer + format: int32 + example: 100 + total: + description: The total + type: integer + format: int32 + example: 10000 + next: + description: The link to the next page of data + type: string + example: /endpoint?limit=10&offset=60 + previous: + description: The link to the previous page of data + type: string + example: /endpoint?limit=10&offset=40 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml b/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml new file mode 100644 index 000000000..f3fead9f5 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/AdvancedSearch.yaml @@ -0,0 +1,31 @@ +type: object +properties: + id: + description: the id of the object + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + label: + description: the label + type: string + example: mylabel + condition_rules_attributes: + description: The attributes for the condition rules + type: array + items: + anyOf: + - $ref: "./ProfileTypeRule.yaml" + - $ref: "./ProfileStatusRule.yaml" + - $ref: "./ProfileAttributeRuleString.yaml" + - $ref: "./ProfileAttributeRuleDate.yaml" + - $ref: "./ProfileAttributeRuleId.yaml" + - $ref: "./RiskRule.yaml" + example: + - type: ProfileTypeRule + comparison_operator: == + value: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - type: ProfileStatusRule + id: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: == + value: Active diff --git a/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml b/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml new file mode 100644 index 000000000..b0c603b07 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/AttributeOption.yaml @@ -0,0 +1,11 @@ +type: object +properties: + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + option: + description: The option + type: string + example: optionname \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml b/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml new file mode 100644 index 000000000..c583409a7 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/AttributeOptions.yaml @@ -0,0 +1,16 @@ +type: object +properties: + id: + description: The ID + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + option: + description: The option + type: string + example: option \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/Profile.yaml b/static/api-specs/nerm/schemas/PATCH/Profile.yaml new file mode 100644 index 000000000..5639cf1c5 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/Profile.yaml @@ -0,0 +1,38 @@ +type: object +properties: + name: + description: the name + type: string + example: testprofile + profile_type_id: + description: The profile_type_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + status: + description: The Status + type: string + enum: [Active, Inactive, On Leave, Terminated] + example: Active + id_proofing_status: + description: The id_proofing_status + type: string + enum: [pending, pass, fail] + example: pending + archived: + description: Return archived items + type: boolean + default: false + example: false + attributes: + description: The attributes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml new file mode 100644 index 000000000..857aa01b3 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml @@ -0,0 +1,71 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: the type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition_object_type + type: string + required: true + enum: [DateAttribute] + example: DateAttribute + condition_object_id: + description: The condition_object_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + secondary_attribute_type: + description: the secondary attribute type + type: string + enum: [DateAttribute] + example: DateAttribute + secondary_attribute_id: + description: The secondary attribute id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator to use for comparison + type: string + enum: ['>', '<', 'after', 'before'] + example: < + value: + description: The value + type: string + required: true + enum: ['Today', ''] + example: Today + secondary_value: + description: The secondary value + type: string + enum: ['after', 'before'] + example: after + tertiary_value: + description: The tertiary value + type: string + example: 30 + _destroy: + description: should this be destroyed + type: boolean + default: false + example: false + + + + diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml new file mode 100644 index 000000000..375d462f3 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml @@ -0,0 +1,50 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the iud + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: the type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition object type + type: string + required: true + enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] + example: ProfileSearchAttribute + condition_object_id: + description: The condition object id + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator to use for comparison + type: string + required: true + enum: ['include?', 'exclude?'] + example: include? + value: + description: the value + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + _destroy: + description: Should this be destroyed? + type: boolean + default: false + example: false diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml new file mode 100644 index 000000000..6be525f0f --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml @@ -0,0 +1,49 @@ +type: object +properties: + id: + description: The Id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition_object_type + type: string + required: true + enum: [TextFieldAttribute, TextAreaAttribute] + example: TextAreaAttribute + condition_object_id: + description: The condition_object_id + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator used for comparisons + type: string + required: true + enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] + example: == + value: + description: The value + type: string + required: true + example: Some value + _destroy: + description: Destroy + type: boolean + default: false + example: false diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml new file mode 100644 index 000000000..cebb7022c --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/ProfileStatusRule.yaml @@ -0,0 +1,30 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: The type + type: string + required: true + enum: [ProfileStatusRule] + example: ProfileStatusRule + comparison_operator: + description: The operator to use to compare + type: string + enum: ['==', '!='] + example: == + value: + description: The value + type: string + enum: [Active, Inactive, Leave of absence, Terminated] + example: Active + _destroy: + description: Should this be destroyed + type: boolean + default: false + example: false + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml new file mode 100644 index 000000000..31d4e7985 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml @@ -0,0 +1,82 @@ +type: object +properties: + name: + description: The name + type: string + example: my_profile_type_name + bypass_dup_protection: + description: Bypass duplicate protection + type: boolean + example: false + archived: + description: Is the profile type archived + type: boolean + example: false + permitted_role_ids: + description: Permitted role ids + type: array + items: + type: string + format: uuid + example: + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9b + profile_type_dup_attributes: + description: Profile type duplicate attributes + type: array + items: + type: object + properties: + id: + description: The ID + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: The profile type id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_namings: + description: Profile type namings + type: array + items: + type: object + properties: + id: + description: The id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: The profile type id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + order: + description: The order the profile type appears + type: integer + minimum: 0 + example: 0 diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml new file mode 100644 index 000000000..04515f193 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/ProfileTypeRule.yaml @@ -0,0 +1,30 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: the type + type: string + required: true + enum: [ProfileTypeRule] + example: ProfileTypeRule + comparison_operator: + description: The operator to use for comparison + type: string + enum: ['==', '!='] + example: == + value: + description: The value to use in the comparison + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + _destroy: + description: Should this Profile type rule be destroyed? + type: boolean + default: false + example: false + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/Profiles.yaml b/static/api-specs/nerm/schemas/PATCH/Profiles.yaml new file mode 100644 index 000000000..74e3ae45c --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/Profiles.yaml @@ -0,0 +1,43 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: + description: the name + type: string + example: profile name here + profile_type_id: + description: the profile type id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + status: + description: the status + type: string + enum: [Active, Inactive, On Leave, Terminated] + example: Active + id_proofing_status: + description: The id proofing status + type: string + enum: [pending, pass, fail] + example: pending + archived: + description: should profile be archived? + type: boolean + default: false + example: false + attributes: + description: The attrbutes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml b/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml new file mode 100644 index 000000000..76197efee --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/RiskRule.yaml @@ -0,0 +1,44 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + type: + description: the type + type: string + required: true + enum: [RiskRule] + example: RiskRule + comparison_operator: + description: The operator to use for comparison + type: string + enum: ['==', '>', '<'] + example: == + value: + description: the value + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + secondary_value: + description: The secondary value + type: string + required: true + enum: [OverallRisk] + example: OverallRisk + _destroy: + description: Should this riskrule be destroyed + type: boolean + default: false + example: false diff --git a/static/api-specs/nerm/schemas/PATCH/Role.yaml b/static/api-specs/nerm/schemas/PATCH/Role.yaml new file mode 100644 index 000000000..4c4d3d454 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/Role.yaml @@ -0,0 +1,18 @@ +type: object +properties: + type: + description: The type + type: string + enum: [NeprofileRole, NeaccessRole] + example: NeprofileRole + name: + description: The name + type: string + example: "Sponsors" + groups: + description: the groups + type: array + items: + type: string + example: + - "ad_group_name" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml b/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml new file mode 100644 index 000000000..a4aa3cbc5 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/RoleProfile.yaml @@ -0,0 +1,13 @@ +type: object +properties: + role_id: + description: the role id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: the profile id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml b/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml new file mode 100644 index 000000000..4230798de --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/RoleProfiles.yaml @@ -0,0 +1,18 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: + description: the role id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: the profile id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/User.yaml b/static/api-specs/nerm/schemas/PATCH/User.yaml new file mode 100644 index 000000000..c8fd5b74c --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/User.yaml @@ -0,0 +1,50 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + required: true + writeOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + name: + description: The name + type: string + example: myusername + email: + description: The email + type: string + format: email + example: test@sailpoint.com + type: + description: The type + type: string + enum: [NeprofileUser, NeaccessUser] + default: NeprofileUser + example: NeprofileUser + profile_id: + description: The profile_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + title: + description: The title + type: string + example: mytitle + status: + description: The status + type: string + enum: [Active, Disabled] + example: Active + login: + description: The login + type: string + example: mylogin + admin: + description: Is the user an admin + type: boolean + example: false + group_strings: + description: The group strings (used in roles later on) + type: string + example: "Administrator_group,Developer_group" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserManager.yaml b/static/api-specs/nerm/schemas/PATCH/UserManager.yaml new file mode 100644 index 000000000..ed89c88bc --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/UserManager.yaml @@ -0,0 +1,13 @@ +type: object +properties: + user_id: + description: The user_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + manager_id: + description: The manager_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml b/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml new file mode 100644 index 000000000..047f19a7a --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/UserManagers.yaml @@ -0,0 +1,18 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: + description: The user_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + manager_id: + description: The manager_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml b/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml new file mode 100644 index 000000000..268ebf8ca --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/UserProfile.yaml @@ -0,0 +1,22 @@ +type: object +properties: + user_id: + description: The user_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: The profile_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + relationship_type: + description: The relationship_type + type: string + enum: [owner, contributor] + example: owner \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml b/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml new file mode 100644 index 000000000..702e4887c --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/UserProfiles.yaml @@ -0,0 +1,27 @@ +type: object +properties: + id: + description: the id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: + description: the user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: the profile id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: the ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + relationship_type: + description: the relationship_type + type: string + enum: [owner, contributor] + example: owner \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserRole.yaml b/static/api-specs/nerm/schemas/PATCH/UserRole.yaml new file mode 100644 index 000000000..51a8819b9 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/UserRole.yaml @@ -0,0 +1,12 @@ +type: object +properties: + user_id: + description: The user_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: + description: The role_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml b/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml new file mode 100644 index 000000000..308a22692 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/UserRoles.yaml @@ -0,0 +1,18 @@ +type: object +properties: + id: + description: The id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + user_id: + description: The user_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: + description: The uuid + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml b/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml new file mode 100644 index 000000000..7fdbf00c1 --- /dev/null +++ b/static/api-specs/nerm/schemas/PATCH/WorkflowSession.yaml @@ -0,0 +1,48 @@ +type: object +properties: + workflow_id: + description: the workflow_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + requester_id: + description: the requester_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + requester_type: + description: the requester type + type: string + enum: [User, NeprofileUser, NeaccessUser] + example: User + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + example: + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df94 + status: + description: the status + type: string + enum: [api_request_sent, approved, assigned, attempting_to_start_workflow, AUTH-STATUS1, AUTH-STATUS2, AUTH-STATUS3, AUTH-STATUS4, AUTH-STATUS5, AUTH-STATUS6, AUTH-STATUS7, AUTH-STATUS8, AUTH-STATUS9, auto_assigned, batch_completed, checking_for_duplicates, closed, completed, courion_add, courion_extend, courion_terminate, courion_update, duplicates_resolved, failed, fulfilled, invitation_sent, ldap_provided, new, non_employee_created, non_employee_updated, notified, pending_approval, pending_assignment, pending_courion_add, pending_courion_extend, pending_courion_terminate, pending_courion_update, pending_creation, pending_fulfillment, pending_ldap, pending_notification, pending_profile_select, pending_request, pending_review, pending_status_change, pending_stored_procedure, pending_trigger, pending_update, processing, profile_check_complete, profiles_selected, rejected, requested, reviewed, soap_request_sent, started_workflow, status_changed, stored_procedure, un_assigned, waiting_on_workflow, workflow_changed] + example: completed + attributes: + description: the attributes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml b/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml new file mode 100644 index 000000000..3d7a14d1c --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/AdvancedSearch.yaml @@ -0,0 +1,24 @@ +type: object +properties: + label: + description: the label + type: string + example: my search label + condition_rules_attributes: + description: The condition rules attributes + type: array + items: + anyOf: + - $ref: "./ProfileTypeRule.yaml" + - $ref: "./ProfileStatusRule.yaml" + - $ref: "./ProfileAttributeRuleString.yaml" + - $ref: "./ProfileAttributeRuleDate.yaml" + - $ref: "./ProfileAttributeRuleId.yaml" + - $ref: "./RiskRule.yaml" + example: + - type: ProfileTypeRule + comparison_operator: == + value: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + + + diff --git a/static/api-specs/nerm/schemas/POST/AttributeOption.yaml b/static/api-specs/nerm/schemas/POST/AttributeOption.yaml new file mode 100644 index 000000000..5df4e59dc --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/AttributeOption.yaml @@ -0,0 +1,11 @@ +type: object +properties: + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + option: + description: The option + type: string + example: option1 \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/Profile.yaml b/static/api-specs/nerm/schemas/POST/Profile.yaml new file mode 100644 index 000000000..ebfbae544 --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/Profile.yaml @@ -0,0 +1,40 @@ +type: object +properties: + name: + description: The name + type: string + example: my profile name + profile_type_id: + description: the profile type id + type: string + format: uuid + required: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + status: + description: the status + type: string + enum: [Active, Inactive, On Leave, Terminated] + example: Active + required: true + id_proofing_status: + description: the id proofing status + type: string + enum: [pending, pass, fail] + example: pending + archived: + description: is this profile archived + type: boolean + default: false + example: false + attributes: + description: the attributes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml new file mode 100644 index 000000000..97af785c5 --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleDate.yaml @@ -0,0 +1,53 @@ +type: object +properties: + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition_object_type + type: string + required: true + enum: [DateAttribute] + example: DateAttribute + condition_object_id: + description: The condition_object_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + secondary_attribute_type: + description: The secondary_attribute_type + type: string + enum: [DateAttribute] + example: DateAttribute + secondary_attribute_id: + description: The secondary_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator to use when comparing + type: string + enum: ['>', '<', 'after', 'before'] + example: after + value: + description: The value + type: string + required: true + enum: ['Today', ''] + example: Today + secondary_value: + description: The secondary_value + type: string + enum: ['after', 'before'] + example: after + tertiary_value: + description: The tertiary_value + type: string + example: 30 + + + + diff --git a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml new file mode 100644 index 000000000..69de2b244 --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleId.yaml @@ -0,0 +1,33 @@ +type: object +properties: + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The conditon object type + type: string + required: true + enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] + example: ProfileSearchAttribute + condition_object_id: + description: The condition object id + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: The operator to use for comparison + type: string + required: true + enum: ['include?', 'exclude?'] + example: include? + value: + description: The value + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + diff --git a/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml new file mode 100644 index 000000000..c86f7999b --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/ProfileAttributeRuleString.yaml @@ -0,0 +1,31 @@ +type: object +properties: + type: + description: The type + type: string + required: true + enum: [ProfileAttributeRule] + example: ProfileAttributeRule + condition_object_type: + description: The condition_object_type + type: string + required: true + enum: [TextFieldAttribute, TextAreaAttribute] + example: TextAreaAttribute + condition_object_id: + description: The condition_object_id + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + comparison_operator: + description: the operator to use for comparison + type: string + required: true + enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] + example: == + value: + description: the value to use for comparison + type: string + required: true + example: Some value diff --git a/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml b/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml new file mode 100644 index 000000000..daae222a3 --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/ProfileStatusRule.yaml @@ -0,0 +1,20 @@ +type: object +properties: + type: + description: the type + type: string + required: true + enum: [ProfileStatusRule] + example: ProfileStatusRule + comparison_operator: + description: The operator to use for comparison + type: string + required: true + enum: ['==', '!='] + example: == + value: + description: The value + type: string + required: true + enum: [Active, Inactive, Leave of absence, Terminated] + example: Active diff --git a/static/api-specs/nerm/schemas/POST/ProfileType.yaml b/static/api-specs/nerm/schemas/POST/ProfileType.yaml new file mode 100644 index 000000000..838a4dd5c --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/ProfileType.yaml @@ -0,0 +1,86 @@ +type: object +properties: + name: + description: The name + type: string + example: great_profile_type + bypass_dup_protection: + description: Bypass duplicate protection? + type: boolean + default: false + example: false + archived: + description: Is this archived + type: boolean + default: false + example: false + permitted_role_ids: + description: Permitted Role ids + type: array + items: + type: string + format: uuid + example: + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9d + profile_type_dup_attributes: + description: Profile type duplicate attribgutes + type: array + items: + type: object + properties: + id: + description: The id + type: string + format: uuid + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: The profile type ID + type: string + format: uuid + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_namings: + description: The profile type namings + type: array + items: + description: The items + type: object + properties: + id: + description: The id + type: string + format: uuid + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + uid: + description: The uid + type: string + minLength: 32 + maxLength: 32 + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_type_id: + description: The profile_type_id + type: string + format: uuid + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: b6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + order: + description: The order which this appears in + type: integer + format: int32 + minimum: 0 + example: 0 diff --git a/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml b/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml new file mode 100644 index 000000000..917b78fca --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/ProfileTypeRule.yaml @@ -0,0 +1,20 @@ +type: object +properties: + type: + description: The type + type: string + required: true + enum: [ProfileTypeRule] + example: ProfileTypeRule + comparison_operator: + description: The operator to use for comparison + type: string + required: true + enum: ['==', '!='] + example: == + value: + description: The value + type: string + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e diff --git a/static/api-specs/nerm/schemas/POST/RiskRule.yaml b/static/api-specs/nerm/schemas/POST/RiskRule.yaml new file mode 100644 index 000000000..3470a64cf --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/RiskRule.yaml @@ -0,0 +1,26 @@ +type: object +properties: + type: + description: The type + type: string + required: true + enum: [RiskRule] + example: RiskRule + comparison_operator: + description: The operator to use for comparison + type: string + enum: ['==', '>', '<'] + example: == + value: + description: The value to use + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + secondary_value: + description: The secondary value to use + type: string + required: true + enum: [OverallRisk] + example: OverallRisk \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/Role.yaml b/static/api-specs/nerm/schemas/POST/Role.yaml new file mode 100644 index 000000000..56b37b06f --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/Role.yaml @@ -0,0 +1,23 @@ +type: object +properties: + uid: + description: the uid + type: string + minLength: 32 + maxLength: 32 + example: "sponsors_role" + type: + description: The role type + type: string + enum: [NeprofileRole, NeaccessRole] + example: NeaccessRole + name: + description: The role name + type: string + example: "Sponsors" + groups: + description: The role's groups + type: array + items: + type: string + example: "ad_group_name" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/RoleProfile.yaml b/static/api-specs/nerm/schemas/POST/RoleProfile.yaml new file mode 100644 index 000000000..eb191e17b --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/RoleProfile.yaml @@ -0,0 +1,12 @@ +type: object +properties: + role_id: + description: The role id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: The profile id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/User.yaml b/static/api-specs/nerm/schemas/POST/User.yaml new file mode 100644 index 000000000..61cf43fd6 --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/User.yaml @@ -0,0 +1,48 @@ +type: object +properties: + name: + description: The users name + type: string + required: true + example: bob + email: + description: Email + type: string + format: email + required: true + example: test@sailpoint.com + type: + description: The user type + type: string + enum: ['NeprofileUser', 'NeaccessUser'] + default: NeprofileUser + example: NeprofileUser + profile_id: + description: The user profile_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + title: + description: The user title + type: string + example: my_user_title + status: + description: The user status + type: string + enum: [Active, Disabled] + required: true + example: Active + login: + description: The user login + type: string + required: true + example: my_user + admin: + description: Is the user an admin + type: boolean + default: false + example: false + group_strings: + description: The users group strings + type: string + example: "Administrator_group,Developer_group" \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/UserManager.yaml b/static/api-specs/nerm/schemas/POST/UserManager.yaml new file mode 100644 index 000000000..cd88d3269 --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/UserManager.yaml @@ -0,0 +1,13 @@ +type: object +properties: + user_id: + description: The user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + manager_id: + description: the manager id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/UserProfile.yaml b/static/api-specs/nerm/schemas/POST/UserProfile.yaml new file mode 100644 index 000000000..b488c1b4f --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/UserProfile.yaml @@ -0,0 +1,22 @@ +type: object +properties: + user_id: + description: The user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_id: + description: the profile id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + ne_attribute_id: + description: The ne_attribute_id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + relationship_type: + description: the relationship type + type: string + enum: [owner, contributor] + example: owner \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/UserRole.yaml b/static/api-specs/nerm/schemas/POST/UserRole.yaml new file mode 100644 index 000000000..baa91986f --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/UserRole.yaml @@ -0,0 +1,13 @@ +type: object +properties: + user_id: + description: the user id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + role_id: + description: the role id + type: string + format: uuid + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml b/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml new file mode 100644 index 000000000..19cbe83ee --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/WorkflowSession.yaml @@ -0,0 +1,46 @@ +type: object +properties: + workflow_id: + description: The workflow id + type: string + format: uuid + required: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + requester_id: + description: The requester id + type: string + format: uuid + required: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + requester_type: + description: The requester type + type: string + enum: [User, NeprofileUser, NeaccessUser] + required: true + example: User + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + example: + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + - db6f8e8b-65c2-47d5-a0db-90bcc4e9df9f + attributes: + description: The attributes + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/Placeholder.yaml b/static/api-specs/nerm/schemas/Placeholder.yaml new file mode 100644 index 000000000..1bd361b3f --- /dev/null +++ b/static/api-specs/nerm/schemas/Placeholder.yaml @@ -0,0 +1,6 @@ +type: object +properties: + placeholder: + description: The placeholder + type: string + example: abc123 diff --git a/static/api-specs/nerm/schemas/Url.yaml b/static/api-specs/nerm/schemas/Url.yaml new file mode 100644 index 000000000..1d9e02557 --- /dev/null +++ b/static/api-specs/nerm/schemas/Url.yaml @@ -0,0 +1,8 @@ +type: object +properties: + url: + description: The url + type: string + format: url + readOnly: true + example: http://www.example.com \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/_index.yaml b/static/api-specs/nerm/schemas/_index.yaml new file mode 100644 index 000000000..ef545b63c --- /dev/null +++ b/static/api-specs/nerm/schemas/_index.yaml @@ -0,0 +1,40 @@ +Url: + $ref: './Url.yaml' +User: + $ref: './GET/User.yaml' +UserManager: + $ref: './GET/UserManager.yaml' +UserRole: + $ref: './GET/UserRole.yaml' +Attribute: + $ref: './GET/Attribute.yaml' +AttributeOption: + $ref: './GET/AttributeOption.yaml' +ProfileType: + $ref: './GET/ProfileType.yaml' +Profile: + $ref: './GET/Profile.yaml' +RiskScore: + $ref: './GET/RiskScore.yaml' +RiskLevel: + $ref: './GET/RiskLevel.yaml' +UserProfile: + $ref: './GET/UserProfile.yaml' +RoleProfile: + $ref: './GET/RoleProfile.yaml' +WorkflowSession: + $ref: './GET/WorkflowSession.yaml' +IdentityProofingResult: + $ref: './GET/IdentityProofingResult.yaml' +AdvancedSearch: + $ref: './GET/AdvancedSearch.yaml' +ConditionRulesAttribute-ProfileTypeRule: + $ref: './GET/ProfileTypeRule.yaml' +ConditionRulesAttribute-ProfileStatusRule: + $ref: './GET/ProfileStatusRule.yaml' +ConditionRulesAttribute-ProfileAttributeRuleDate: + $ref: './GET/ProfileAttributeRuleDate.yaml' +ConditionRulesAttribute-ProfileAttributeRuleId: + $ref: './GET/ProfileAttributeRuleId.yaml' +ConditionRulesAttribute-ProfileAttributeRuleString: + $ref: './GET/ProfileAttributeRuleString.yaml' \ No newline at end of file