Returns the environments Resource.
Close httplib2 connections.
create(parent, body=None, securityProfileId=None, x__xgafv=None)
CreateSecurityProfile create a new custom security profile.
DeleteSecurityProfile delete a profile with all its revisions.
GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)
ListSecurityProfileRevisions lists all the revisions of the security profile.
Retrieves the next page of results.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
UpdateSecurityProfile update the metadata of security profile.
close()
Close httplib2 connections.
create(parent, body=None, securityProfileId=None, x__xgafv=None)
CreateSecurityProfile create a new custom security profile.
Args:
parent: string, Required. Name of organization. Format: organizations/{org} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
}
securityProfileId: string, Required. The ID to use for the SecurityProfile, which will become the final component of the action's resource name. This value should be 1-63 characters and validated by "(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)".
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.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
}
delete(name, x__xgafv=None)
DeleteSecurityProfile delete a profile with all its revisions.
Args:
name: string, Required. Name of profile. Format: organizations/{org}/securityProfiles/{profile} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
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.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
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.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
},
],
}
listRevisions(name, pageSize=None, pageToken=None, x__xgafv=None)
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.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
},
],
}
listRevisions_next()
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.
list_next()
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
UpdateSecurityProfile update the metadata of security profile.
Args:
name: string, Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a SecurityProfile resource.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
}
updateMask: string, Required. The list of fields to update.
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.
"description": "A String", # Description of the security profile.
"displayName": "A String", # DEPRECATED: DO NOT USE 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}
"profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
"categories": [ # List of categories of profile config.
{ # Advanced API Security provides security profile that scores the following categories.
"abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
},
"authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
},
"cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
},
"mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
},
"mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
},
"threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
},
},
],
},
"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. DEPRECATED: DO NOT USE 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.
},
],
}