| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.securityProfiles.html">securityProfiles</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.securityProfiles.environments.html">environments()</a></code> |
| </p> |
| <p class="firstline">Returns the environments Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.</p> |
| <p class="toc_element"> |
| <code><a href="#listRevisions">listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">ListSecurityProfileRevisions lists all the revisions of the security profile.</p> |
| <p class="toc_element"> |
| <code><a href="#listRevisions_next">listRevisions_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization. |
| |
| Args: |
| name: string, Required. Security profile in the following format: `organizations/{org}/securityProfiles/{profile}'. Profile may optionally contain revision ID. If revision ID is not provided, the response will contain latest revision by default. Example: organizations/testOrg/securityProfiles/testProfile@5 (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a SecurityProfile resource. |
| "displayName": "A String", # Display name of the security profile. |
| "environments": [ # List of environments attached to security profile. |
| { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile. |
| "attachTime": "A String", # Output only. Time at which environment was attached to the security profile. |
| "environment": "A String", # Output only. Name of the environment. |
| }, |
| ], |
| "maxScore": 42, # Output only. Maximum security score that can be generated by this profile. |
| "minScore": 42, # Output only. Minimum security score that can be generated by this profile. |
| "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} |
| "revisionCreateTime": "A String", # Output only. The time when revision was created. |
| "revisionId": "A String", # Output only. Revision ID of the security profile. |
| "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. |
| "revisionUpdateTime": "A String", # Output only. The time when revision was updated. |
| "scoringConfigs": [ # List of profile scoring configs in this revision. |
| { # Security configurations to manage scoring. |
| "description": "A String", # Description of the config. |
| "scorePath": "A String", # Path of the component config used for scoring. |
| "title": "A String", # Title of the config. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles. |
| |
| Args: |
| parent: string, Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}` (required) |
| pageSize: integer, The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned. |
| pageToken: string, A page token, received from a previous `ListSecurityProfiles` call. Provide this to retrieve the subsequent page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ListSecurityProfiles. |
| "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| "securityProfiles": [ # List of security profiles in the organization. The profiles may be attached or unattached to any environment. This will return latest revision of each profile. |
| { # Represents a SecurityProfile resource. |
| "displayName": "A String", # Display name of the security profile. |
| "environments": [ # List of environments attached to security profile. |
| { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile. |
| "attachTime": "A String", # Output only. Time at which environment was attached to the security profile. |
| "environment": "A String", # Output only. Name of the environment. |
| }, |
| ], |
| "maxScore": 42, # Output only. Maximum security score that can be generated by this profile. |
| "minScore": 42, # Output only. Minimum security score that can be generated by this profile. |
| "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} |
| "revisionCreateTime": "A String", # Output only. The time when revision was created. |
| "revisionId": "A String", # Output only. Revision ID of the security profile. |
| "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. |
| "revisionUpdateTime": "A String", # Output only. The time when revision was updated. |
| "scoringConfigs": [ # List of profile scoring configs in this revision. |
| { # Security configurations to manage scoring. |
| "description": "A String", # Description of the config. |
| "scorePath": "A String", # Path of the component config used for scoring. |
| "title": "A String", # Title of the config. |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listRevisions">listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>ListSecurityProfileRevisions lists all the revisions of the security profile. |
| |
| Args: |
| name: string, Required. For a specific profile, list all the revisions. Format: `organizations/{org}/securityProfiles/{profile}` (required) |
| pageSize: integer, The maximum number of profile revisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. |
| pageToken: string, A page token, received from a previous `ListSecurityProfileRevisions` call. Provide this to retrieve the subsequent page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ListSecurityProfileRevisions. |
| "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| "securityProfiles": [ # List of security profile revisions. The revisions may be attached or unattached to any environment. |
| { # Represents a SecurityProfile resource. |
| "displayName": "A String", # Display name of the security profile. |
| "environments": [ # List of environments attached to security profile. |
| { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile. |
| "attachTime": "A String", # Output only. Time at which environment was attached to the security profile. |
| "environment": "A String", # Output only. Name of the environment. |
| }, |
| ], |
| "maxScore": 42, # Output only. Maximum security score that can be generated by this profile. |
| "minScore": 42, # Output only. Minimum security score that can be generated by this profile. |
| "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} |
| "revisionCreateTime": "A String", # Output only. The time when revision was created. |
| "revisionId": "A String", # Output only. Revision ID of the security profile. |
| "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. |
| "revisionUpdateTime": "A String", # Output only. The time when revision was updated. |
| "scoringConfigs": [ # List of profile scoring configs in this revision. |
| { # Security configurations to manage scoring. |
| "description": "A String", # Description of the config. |
| "scorePath": "A String", # Path of the component config used for scoring. |
| "title": "A String", # Title of the config. |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listRevisions_next">listRevisions_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
