policies
Use this resource to retrieve a list of policies that meet specified criteria.
Method summary
HTTP Method | Path | Description |
---|---|---|
GET | /bwl/policies | Returns a list of policy models that meet specified criteria. Only policies that you have access to are returned. |
GET /policies
- Description
- Use this method to return a list of policies that meet specified criteria.
- Resource information
-
Requirements Description Response format JSON Requires authentication Yes Supports OAuth 2 client credentials Yes, using an Artifact Reporting Service ID
- Parameters
-
Name Location Description Required Type X-IBM-API-Version Header The version of this API. If you are programming against the API, you MUST include the version. If omitted, the latest version of the API is used, which might be incompatible with prior versions. The current value is
1.0.0
.No String X-On-Behalf-Of Header The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String archived-state Query Filters the results based on the archived state of the artifact. If not specified, 'active' is assumed. The only allowed values are
active
orarchived
.No String name Query If specified, only policy models with this exact name are returned. Either a name or a tag must be specified, but not both. No String space-id Query The identifier of the space to search within. If not specified, the search is account wide. If this space contains child spaces, the child spaces will also be searched. If both a space-id and space-name are specified, the space-id takes precedence. No String space-name Query The name of the space to search within. If not specified, the search is account wide. If both a space-id and space-name are specified, the space-id takes precedence. No String tag Query If specified, only policy models with this exact tag are returned. Either name or tag must be specified, but not both. No String
- Response
-
- Example input
-
LIST all policies named MyPolicy in an account that you have access to:
- Using OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/bwl/policies?name=MyPolicy"
- Using OAuth 2 client credentials with user
context:
curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/bwl/policies?name=MyPolicy"
- Using OAuth 2 client
credentials:
- Example output
-
LIST all policies named MyPolicy in an account that you have access to:
[ { "id": "250062", "name": "MyPolicy", "type": "policy", "space-ids": [ "250006" ], "space-names": [ "MySpace" ], "archived-state": "active", "last-modified-date": "2017-01-03T22:41:41.384+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-01-01T22:41:41.260+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" } }, { "id": "250093", "name": "MyPolicy", "type": "policy", "space-ids": [ "250087" ], "space-names": [ "MyOtherSpace" ], "archived-state": "active", "last-modified-date": "2017-02-03T22:41:41.384+0000", "last-modified-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" }, "created-date": "2017-02-01T22:41:41.260+0000", "created-by-user": { "id": "50029", "full-name": "Edith Editor", "email-address": "edith" } } ]
- Response messages
-
HTTP code Reason 200 The request was completed successfully.
400 There was an error processing the request. Required parameters were missing or contained invalid values.
401 This user didn't pass authentication. This response could appear for the following reasons:- An invalid username or password was provided.
- This user belongs to multiple accounts and an account wasn't specified in the request.
403 Access is forbidden. 404 The policy-id parameter identifies a policy that does not exist in this account.
- More details
- To get more details about the operations and response values, use a Swagger Editor to view the APIs:
- Download the rest-apis.zip file.
- Extract the openapi.yaml file.
- Open a web browser, and navigate to https://editor-next.swagger.io/.
- Import openapi.yaml using the option.