REST Resource: organizations.securityProfiles

Resource: SecurityProfile

Represents a SecurityProfile resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "revisionId": string,
  "revisionCreateTime": string,
  "revisionUpdateTime": string,
  "revisionPublishTime": string,
  "scoringConfigs": [
    {
      object (ScoringConfig)
    }
  ],
  "environments": [
    {
      object (Environment)
    }
  ],
  "maxScore": integer,
  "minScore": integer,
  "profileConfig": {
    object (ProfileConfig)
  },
  "description": string
}
Fields
name

string

Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
displayName
(deprecated)

string

DEPRECATED: DO NOT USE Display name of the security profile.
revisionId

string (int64 format)

Output only. Revision ID of the security profile.
revisionCreateTime

string (Timestamp format)

Output only. The time when revision was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
revisionUpdateTime

string (Timestamp format)

Output only. The time when revision was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
revisionPublishTime
(deprecated)

string (Timestamp format)

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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
scoringConfigs[]

object (ScoringConfig)

List of profile scoring configs in this revision.
environments[]

object (Environment)

List of environments attached to security profile.
maxScore

integer

Output only. Maximum security score that can be generated by this profile.
minScore

integer

Output only. Minimum security score that can be generated by this profile.
profileConfig

object (ProfileConfig)

Required. Customized profile configuration that computes the security score.
description

string

Description of the security profile.

ScoringConfig

Security configurations to manage scoring.

JSON representation 
{
  "title": string,
  "scorePath": string,
  "description": string
}
Fields
title

string

Title of the config.
scorePath

string

Path of the component config used for scoring.
description

string

Description of the config.

Environment

Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.

JSON representation 
{
  "environment": string,
  "attachTime": string
}
Fields
environment

string

Output only. Name of the environment.
attachTime

string (Timestamp format)

Output only. Time at which environment was attached to the security profile.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ProfileConfig

ProfileConfig defines a set of categories and policies which will be used to compute security score.

JSON representation 
{
  "categories": [
    {
      object (Category)
    }
  ]
}
Fields
categories[]

object (Category)

List of categories of profile config.

Category

Advanced API Security provides security profile that scores the following categories.

JSON representation 
{

  // Union field CategoryType can be only one of the following:
  "abuse": {
    object (Abuse)
  },
  "mediation": {
    object (Mediation)
  },
  "authorization": {
    object (Authorization)
  },
  "threat": {
    object (Threat)
  },
  "mtls": {
    object (MTLS)
  },
  "cors": {
    object (CORS)
  }
  // End of list of possible types for union field CategoryType.
}
Fields
Union field CategoryType. LINT.IfChange CategoryType can be only one of the following:
abuse

object (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.
mediation

object (Mediation)

Checks to see if you have a mediation policy in place.
authorization

object (Authorization)

Checks to see if you have an authorization policy in place.
threat

object (Threat)

Checks to see if you have a threat protection policy in place.
mtls

object (MTLS)

Checks to see if you have configured mTLS for the target server.
cors

object (CORS)

Checks to see if you have CORS policy in place.

Abuse

This type has no fields.

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.

Mediation

This type has no fields.

By default, following policies will be included: - OASValidation - SOAPMessageValidation

Authorization

This type has no fields.

By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey

Threat

This type has no fields.

By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection

MTLS

This type has no fields.

Checks to see if you have configured mTLS for the target server.

CORS

This type has no fields.

Checks to see if you have CORS policy in place.

Methods

create

 CreateSecurityProfile create a new custom security profile.

delete

 DeleteSecurityProfile delete a profile with all its revisions.

get

 GetSecurityProfile gets the specified security profile.

list

 ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.

listRevisions

 ListSecurityProfileRevisions lists all the revisions of the security profile.

patch

 UpdateSecurityProfile update the metadata of security profile.