{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"40eb08e3-e8e5-4dab-a888-690a81bbf3af","name":"12.5.x","description":"### Background\n\nWe are adhering to REST API best practices in the creation of this documentation.\n\nWe are adhering to [http://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md](http://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md) except where explicitly listed **here.**\n\nIDAPI references - [http://docs.hitachi-id.com/content/en/api.pdf](http://docs.hitachi-id.com/content/en/api.pdfStartFragmentBackwards)\n\n[StartFragment](http://docs.hitachi-id.com/content/en/api.pdfStartFragmentBackwards)\n\n#### Backwards compatibility\n\nBravura Security's REST API version will be incremented if a backwards incompatible change has been introduced. And if a backwards compatibility item is introduced we will do everything we can to preserve the past definition of the API for the period of time the versions are in support. A breaking change on the API that violates this will only be considered if a security concern or data loss issue is flagged in the API in question that would warrant a break.\n\n### Resource Summary\n\n| **Resource** | **Description** | **Version** |\n| --- | --- | --- |\n| Account | An account is an object identified and discovered from a target system. It can be referenced by other resources such as User resources and Managed Account resources. An account can hold multiple Group Member references that explains the groups it’s a member of and attributes of that membership. | 1 |\n| Attribute | An attribute is an object identified and discovered from a target system, profile or group. It can be referenced by other resources such as User resources, Managed Account resources, Account resources and Group resources. An attribute can hold multiple may hold multiple values. | 1 |\n| Credential | A credential is referenced by a User. It can take the form of a password and/or a Question/Answer. A user can reference multiple credentials. | 1 |\n| Group | A group is a resource identified and discovered from a target system. It references a collection of memberships and attributes. | 1 |\n| Managed Account | A managed account is an account in which we are managing secrets too. It references an account resource and can have multiple secrets associated to it. In the future it might be similar to a Managed Group where it can hold direct policies about how the account should be governed. For example, a user account vs a service account. | 1 |\n| Managed System Policy | A managed system policy is a resource that is defined in Bravura Security Fabric. It references a collection of managed systems and managed accounts. | 1 |\n| Managed System | A managed system is a resource that is defined in Bravura Security Fabric. It references managed accounts. | 1 |\n| Operation | An operation is an object that defines a task that has been submitted by the API. It references the execution details and the status of the task. | 1 |\n| Secret | A secret is referenced by a Managed Account. It can take the form of a password and/or a file. A managed account can reference multiple secrets but in common operation it’s often limited to just one secret. | 1 |\n| Target Group | A target group is an object defined in Bravura Security Fabric an is a collection of target systems sharing a password policy. | 1 |\n| Target System | A target system is a object defined in Bravura Security Fabric. It contains a collection of accounts and groups. | 1 |\n| User | A user is a person who can log into the Bravura Security Fabric. They can have multiple accounts associated with them. The object can also reference attributes. | 1 |\n\n### Authentication\n\nTo authenticate to a request, add a bearer token to the Authorization HTTP header.\n\n#### Retrieving a bearer token\n\nTo get a bearer token, the REST API has an IdentityServer established to mint tokens. To authenticate, follow the **Resource owner password** grant type for IdentityServer4.\n\n##### Authentication Example\n\nFor external authentication to the REST API, the client ID is `passwordclient`. There is no client secret. For a user to be able to authenticate externally, they must be members of the `_EXPLICIT_REST_API_USERS_` user class.\n\n```\nPOST {{scheme}}://{{hostname}}/{{instancename}}/identity/connect/token\nContent-Type: application/x-www-form-urlencoded\n    client_id=passwordclient&\n    grant_type=password&\n    username={{username}}&\n    password={{password}}\n\n```\n\nThe resulting response will provide an `access_token` which is the bearer token used for the Authorization HTTP header in the REST API requests. The response also includes a `refresh_token` which can be used to extend the lifetime of the authenticated user's session.\n\nExample response:\n\n``` json\n{\n    \"access_token\": \"FB1A619D121BA73B52B5BF2FD96D3669075A158918A66FC6E5D4845CEA035F29\",\n    \"expires_in\": 3600,\n    \"token_type\": \"Bearer\",\n    \"refresh_token\": \"D2FE60948CA91B61C8EC82BD9D2183FC1F5B7E7A41A47D1F0BE749A00F3E0F4E\",\n    \"scope\": \"api.read api.write offline_access\"\n}\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7060447","team":3283228,"collectionId":"40eb08e3-e8e5-4dab-a888-690a81bbf3af","publishedId":"2s8YekQZmR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/7060447/2s8YekQZmR","privateUrl":"https://go.postman.co/documentation/7060447-40eb08e3-e8e5-4dab-a888-690a81bbf3af","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-05-13T04:43:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/40ede95af1caa0cd3a68d5aeff5d740557ca121fe1908a5e9d0759ff588451b4","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s8YekQZmR"}