Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

List baseline project policies

GET
/api/v1/projects/{projectId}/policies/baseline 

       

        

         curl
          
         --request
          
         GET
          
         \
        

       

       

        

          
         --url
          
         https://localhost:10001/api/v1/projects/1/policies/baseline
          
         \
        

       

       

        

          
         --header
          
         '
         Authorization: 
          
         '

List all baseline policies applied to a specific project

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
integer

Project ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Baseline project policies

Media type application/json
Array
object
controls
Array
object
citations
Array
object
title
string
url
string
controlCode
string
controlId
integer
declarations
Array
object
cid
string
createdAt
string
fileAttachments
Array
object
contentType
string
declarationId
integer
description
string
fileName
string
id
integer
isPublic
boolean
retentionExpires
string
reviewId
integer
sizeBytes
integer
storagePath
string
uploadedAt
string
uploadedBy
string
id
integer
isAutomated
boolean
isReadyForReview
boolean
projectPolicyControlId
integer
statement
string
subjectLine
string
submittedAt
string
submittedBy
string
updatedAt
string
description
string
indicators
Array
object
applicationUuid
string
createdAt

Audit

string
criteria
Array
declarationProfile

Declaration behavior

object
emitOn

“pass” | “fail” | “both” | “none”

string
Allowed values: pass fail both none
statementTemplate
string
titleTemplate
string
extractionRules

Custom indicator fields

Array
id
integer
indicatorId
string
lastEvaluatedAt
string
parameters
Array
projectPolicyControlId
integer
status

State

string
Allowed values: active disabled archived
triggerType
string
Allowed values: event
updatedAt
string
projectPolicyControlId
integer
reviews
Array
object
cid
string
commentType
string
createdAt
string
fileAttachments
Array
object
contentType
string
declarationId
integer
description
string
fileName
string
id
integer
isPublic
boolean
retentionExpires
string
reviewId
integer
sizeBytes
integer
storagePath
string
uploadedAt
string
uploadedBy
string
id
integer
outcome
string
projectPolicyControlId
integer
statement
string
subjectLine
string
submittedAt
string
submittedBy
string
updatedAt
string
status
string
title
string
credential
object
credential
object
credentialId
string
expiresAt
string
id
integer
issuedAt
string
issuedBy
string
projectPolicyId
integer
revoked
boolean
revokedAt
string
revokedBy
string
revokedReason
string
sourceCid
string
projectPolicy
object
appliedAt
string
appliedBy
string
archivedAt
string
archivedBy
string
cid
string
createdAt
string
id
integer
isArchived
boolean
isReapplied
boolean
name
string
policyId
integer
projectId
integer
slug
string
status
string
subjectCid
string
updatedAt
string
Example 

                                                        

                                                         

                                                          [
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          {
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          "controls"
                                                          : [
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          {
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          "indicators"
                                                          : [
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          {
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          "declarationProfile"
                                                          : {
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          "emitOn"
                                                          : 
                                                          "
                                                          pass
                                                          "
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          },
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          "status"
                                                          : 
                                                          "
                                                          active
                                                          "
                                                          ,
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          "triggerType"
                                                          : 
                                                          "
                                                          event
                                                          "
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          }
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          ]
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          }
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          ]
                                                         

                                                        

                                                        

                                                         

                                                           
                                                          }
                                                         

                                                        

                                                        

                                                         

                                                          ]

400

Section titled “400 ”

Bad request - Invalid project ID

Media type application/json
object
key
additional properties
string
Example generated

                                                            

                                                             

                                                              {
                                                             

                                                            

                                                            

                                                             

                                                               
                                                              "additionalProperty"
                                                              : 
                                                              "
                                                              example
                                                              "
                                                             

                                                            

                                                            

                                                             

                                                              }

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated

                                                            

                                                             

                                                              {
                                                             

                                                            

                                                            

                                                             

                                                               
                                                              "additionalProperty"
                                                              : 
                                                              "
                                                              example
                                                              "
                                                             

                                                            

                                                            

                                                             

                                                              }

403

Section titled “403 ”

Forbidden - No project access

Media type application/json
object
key
additional properties
string
Example generated

                                                            

                                                             

                                                              {
                                                             

                                                            

                                                            

                                                             

                                                               
                                                              "additionalProperty"
                                                              : 
                                                              "
                                                              example
                                                              "
                                                             

                                                            

                                                            

                                                             

                                                              }

404

Section titled “404 ”

Project not found

Media type application/json
object
key
additional properties
string
Example generated

                                                            

                                                             

                                                              {
                                                             

                                                            

                                                            

                                                             

                                                               
                                                              "additionalProperty"
                                                              : 
                                                              "
                                                              example
                                                              "
                                                             

                                                            

                                                            

                                                             

                                                              }

500

Section titled “500 ”

Internal server error

Media type application/json
object
key
additional properties
string
Example generated

                                                            

                                                             

                                                              {
                                                             

                                                            

                                                            

                                                             

                                                               
                                                              "additionalProperty"
                                                              : 
                                                              "
                                                              example
                                                              "
                                                             

                                                            

                                                            

                                                             

                                                              }