REST API documentation
minder/v1/minder.proto (version not set)
Download OpenAPI specification:Download
ArtifactService_GetArtifactByName
path Parameters
name required | string.+ |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "artifact": {
- "artifactPk": "string",
- "owner": "string",
- "name": "string",
- "type": "string",
- "visibility": "string",
- "repository": "string",
- "versions": [
- {
- "versionId": "string",
- "tags": [
- "string"
], - "sha": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}, - "versions": [
- {
- "versionId": "string",
- "tags": [
- "string"
], - "sha": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}
ArtifactService_GetArtifactById
path Parameters
id required | string |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "artifact": {
- "artifactPk": "string",
- "owner": "string",
- "name": "string",
- "type": "string",
- "visibility": "string",
- "repository": "string",
- "versions": [
- {
- "versionId": "string",
- "tags": [
- "string"
], - "sha": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}, - "versions": [
- {
- "versionId": "string",
- "tags": [
- "string"
], - "sha": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}
ArtifactService_ListArtifacts2
query Parameters
provider | string |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
from | string |
Responses
Response samples
- 200
{- "results": [
- {
- "artifactPk": "string",
- "owner": "string",
- "name": "string",
- "type": "string",
- "visibility": "string",
- "repository": "string",
- "versions": [
- {
- "versionId": "string",
- "tags": [
- "string"
], - "sha": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}
]
}
ArtifactService_ListArtifacts
path Parameters
provider required | string |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
from | string |
Responses
Response samples
- 200
{- "results": [
- {
- "artifactPk": "string",
- "owner": "string",
- "name": "string",
- "type": "string",
- "visibility": "string",
- "repository": "string",
- "versions": [
- {
- "versionId": "string",
- "tags": [
- "string"
], - "sha": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}
]
}
OAuthService_StoreProviderToken2
Request Body schema: application/jsonrequired
provider | string |
accessToken | string |
owner | string |
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. |
Responses
Request samples
- Payload
{- "provider": "string",
- "accessToken": "string",
- "owner": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}
Response samples
- 200
{ }
OAuthService_GetAuthorizationURL
query Parameters
cli | boolean |
port | integer <int32> |
owner | string |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
redirectUrl | string |
config | object config is a JSON object that can be used to pass additional configuration |
providerClass | string |
Responses
Response samples
- 200
{- "url": "string",
- "state": "string"
}
VerifyProviderCredential verifies that a credential has been created matching the enrollment nonce
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
enrollmentNonce | string enrollment_nonce is the state parameter returned when enrolling the provider |
Responses
Response samples
- 200
{- "created": true,
- "providerName": "string"
}
VerifyProviderTokenFrom verifies that a token has been created for a provider since given timestamp
path Parameters
provider required | string |
timestamp required | string <date-time> |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "status": "string"
}
VerifyProviderTokenFrom verifies that a token has been created for a provider since given timestamp
path Parameters
timestamp required | string <date-time> |
query Parameters
provider | string |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "status": "string"
}
OAuthService_StoreProviderToken
path Parameters
provider required | string |
Request Body schema: application/jsonrequired
accessToken | string |
owner | string |
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. |
Responses
Request samples
- Payload
{- "accessToken": "string",
- "owner": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}
Response samples
- 200
{ }
RepositoryService_ListRepositories2
query Parameters
provider | string |
limit | string <int64> |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
cursor | string |
Responses
Response samples
- 200
{- "results": [
- {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}
], - "cursor": "string"
}
RepositoryService_ListRepositories
path Parameters
provider required | string |
query Parameters
limit | string <int64> |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
cursor | string |
Responses
Response samples
- 200
{- "results": [
- {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}
], - "cursor": "string"
}
RepositoryService_ListRemoteRepositoriesFromProvider
path Parameters
provider required | string |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "results": [
- {
- "owner": "string",
- "name": "string",
- "repoId": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "registered": true
}
], - "entities": [
- {
- "entity": {
- "context": {
- "projectId": "string",
- "provider": "string"
}, - "type": "ENTITY_UNSPECIFIED",
- "properties": { }
}, - "registered": true
}
]
}
RepositoryService_ListRemoteRepositoriesFromProvider2
query Parameters
provider | string |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "results": [
- {
- "owner": "string",
- "name": "string",
- "repoId": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "registered": true
}
], - "entities": [
- {
- "entity": {
- "context": {
- "projectId": "string",
- "provider": "string"
}, - "type": "ENTITY_UNSPECIFIED",
- "properties": { }
}, - "registered": true
}
]
}
RepositoryService_GetRepositoryById
path Parameters
repositoryId required | string |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "repository": {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}
}
RepositoryService_GetRepositoryByName2
path Parameters
name required | string.+ |
query Parameters
provider | string |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "repository": {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}
}
RepositoryService_DeleteRepositoryByName2
path Parameters
name required | string.+ |
query Parameters
provider | string |
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "name": "string"
}
RepositoryService_GetRepositoryByName
path Parameters
provider required | string |
name required | string.+ |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "repository": {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}
}
RepositoryService_DeleteRepositoryByName
path Parameters
provider required | string |
name required | string.+ |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "name": "string"
}
RepositoryService_RegisterRepository
path Parameters
provider required | string |
Request Body schema: application/jsonrequired
object (v1UpstreamRepositoryRef) | |
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
object (v1UpstreamEntityRef) UpstreamEntityRef providers enough information for the provider to identify the entity in the upstream system. |
Responses
Request samples
- Payload
{- "repository": {
- "owner": "string",
- "name": "string",
- "repoId": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "registered": true
}, - "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "entity": {
- "context": {
- "projectId": "string",
- "provider": "string"
}, - "type": "ENTITY_UNSPECIFIED",
- "properties": { }
}
}
Response samples
- 200
{- "result": {
- "repository": {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}, - "status": {
- "success": true,
- "error": "string"
}
}
}
RepositoryService_RegisterRepository2
Request Body schema: application/jsonrequired
provider | string |
object (v1UpstreamRepositoryRef) | |
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
object (v1UpstreamEntityRef) UpstreamEntityRef providers enough information for the provider to identify the entity in the upstream system. |
Responses
Request samples
- Payload
{- "provider": "string",
- "repository": {
- "owner": "string",
- "name": "string",
- "repoId": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "registered": true
}, - "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "entity": {
- "context": {
- "projectId": "string",
- "provider": "string"
}, - "type": "ENTITY_UNSPECIFIED",
- "properties": { }
}
}
Response samples
- 200
{- "result": {
- "repository": {
- "id": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "owner": "string",
- "name": "string",
- "repoId": "string",
- "hookId": "string",
- "hookUrl": "string",
- "deployUrl": "string",
- "cloneUrl": "string",
- "hookName": "string",
- "hookType": "string",
- "hookUuid": "string",
- "isPrivate": true,
- "isFork": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "defaultBranch": "string",
- "license": "string",
- "properties": { }
}, - "status": {
- "success": true,
- "error": "string"
}
}
}
Response samples
- 200
{- "user": {
- "id": 0,
- "identitySubject": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "projects": [
- {
- "projectId": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "string"
}
], - "projectRoles": [
- {
- "role": {
- "name": "string",
- "displayName": "string",
- "description": "string"
}, - "project": {
- "projectId": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "string"
}
}
]
}
Request samples
- Payload
{ }
Response samples
- 200
{- "id": 0,
- "organizationId": "string",
- "organizatioName": "string",
- "projectId": "string",
- "projectName": "string",
- "identitySubject": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}
ResolveInvitation allows a user to accept or decline an invitation to a project given the code for the invitation. A user may call ResolveInvitation to accept or decline an invitation even if they have not called CreateUser. If a user accepts an invitation via this call before calling CreateUser, a Minder user record will be created, but no additional projects will be created (unlike CreateUser, which will also create a default project).
path Parameters
code required | string code is the code of the invitation to resolve. |
query Parameters
accept | boolean accept is true if the invitation is accepted, false if it is rejected. |
Responses
Response samples
- 200
{- "role": "string",
- "email": "string",
- "project": "string",
- "isAccepted": true,
- "projectDisplay": "string"
}
ListInvitations returns a list of invitations for the user based on the user's registered email address. Note that a user who receives an invitation code may still accept the invitation even if the code was directed to a different email address. This is because understanding the routing of email messages is beyond the scope of Minder.
This API endpoint may be called without the logged-in user
previously having called CreateUser
.
Responses
Response samples
- 200
{- "invitations": [
- {
- "role": "string",
- "email": "string",
- "project": "string",
- "code": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "expired": true,
- "sponsor": "string",
- "sponsorDisplay": "string",
- "projectDisplay": "string",
- "inviteUrl": "string",
- "emailSkipped": true
}
]
}
ProfileService_CreateProfile
Request Body schema: application/jsonrequired
object (v1Profile) Profile defines a profile that is user defined. | |||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
Response samples
- 200
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
ProfileService_UpdateProfile
Request Body schema: application/jsonrequired
object (v1Profile) Profile defines a profile that is user defined. | |||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
Response samples
- 200
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
ProfileService_GetProfileByName
path Parameters
name required | string.+ name is the name of the profile to get |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
ProfileService_GetProfileStatusByName
path Parameters
name required | string.+ name is the name of the profile to get |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
entity.type | string Default: "ENTITY_UNSPECIFIED" Enum: "ENTITY_UNSPECIFIED" "ENTITY_REPOSITORIES" "ENTITY_BUILD_ENVIRONMENTS" "ENTITY_ARTIFACTS" "ENTITY_PULL_REQUESTS" "ENTITY_RELEASE" "ENTITY_PIPELINE_RUN" "ENTITY_TASK_RUN" "ENTITY_BUILD" entity is the entity to get status for. Incompatible with |
entity.id | string id is the ID of the entity to get status for. Incompatible with |
all | boolean |
rule | string rule is the type of the rule. Deprecated in favor of rule_type |
ruleType | string |
ruleName | string |
Responses
Response samples
- 200
{- "profileStatus": {
- "profileId": "string",
- "profileName": "string",
- "profileStatus": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "profileDisplayName": "string"
}, - "ruleEvaluationStatus": [
- {
- "profileId": "string",
- "ruleId": "string",
- "ruleName": "string",
- "entity": "string",
- "status": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "entityInfo": {
- "property1": "string",
- "property2": "string"
}, - "details": "string",
- "guidance": "string",
- "remediationStatus": "string",
- "remediationLastUpdated": "2019-08-24T14:15:22Z",
- "remediationDetails": "string",
- "ruleTypeName": "string",
- "ruleDescriptionName": "string",
- "alert": {
- "status": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "details": "string",
- "url": "string"
}, - "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "ruleEvaluationId": "string",
- "remediationUrl": "string",
- "ruleDisplayName": "string",
- "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
]
}
ProfileService_GetProfileById
path Parameters
id required | string id is the id of the profile to get |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
ProfileService_PatchProfile
path Parameters
id required | string The id of the profile to patch. Same explanation about explicitness as for the context |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Request Body schema: application/jsonrequired
The patch to apply to the profile
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
id | string id is the id of the profile. This is optional and is set by the system. |
name | string name is the name of the profile instance. |
labels | Array of strings labels are a set of system-provided attributes which can be used to filter profiles and status results. Labels cannot be set by the user, but are returned in ListProfiles. Labels use DNS label constraints, with a possible namespace prefix separated by a colon (:). They are intended to allow filtering, but not to store arbitrary metadata. DNS labels are 1-63 character alphanumeric strings with internal hyphens. An RE2-style validation regex would be: DNS_STR = "a-zA-Z0-9?" ($DNS_STR:)?$DNS_STR |
Array of objects (ProfileRule) These are the entities that one could set in the profile. | |
Array of objects (ProfileRule) | |
Array of objects (ProfileRule) | |
Array of objects (ProfileRule) | |
Array of objects (ProfileRule) | |
Array of objects (ProfileRule) | |
Array of objects (ProfileRule) | |
Array of objects (ProfileRule) | |
Array of objects (ProfileSelector) | |
remediate | string (whether and how to remediate (on,off,dry_run)
this is optional and defaults to "off") |
alert | string (whether and how to alert (on,off,dry_run)
this is optional and defaults to "on") |
type | string type is a placeholder for the object type. It should always be set to "profile". |
version | string (version is the version of the profile type. In this case, it is "v1") |
displayName | string display_name is the display name of the profile. |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
Response samples
- 200
{- "profile": {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
}
ProfileService_GetProfileStatusByProject
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "profileStatus": [
- {
- "profileId": "string",
- "profileName": "string",
- "profileStatus": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "profileDisplayName": "string"
}
]
}
ProfileService_ListProfiles
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
labelFilter | string Filter profiles to only those matching the specified labels. The default is to return all user-created profiles; the string "*" can be used to select all profiles, including system profiles. This syntax may be expanded in the future. |
Responses
Response samples
- 200
{- "profiles": [
- {
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "id": "string",
- "name": "string",
- "labels": [
- "string"
], - "repository": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "buildEnvironment": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "artifact": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pullRequest": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "release": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "pipelineRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "taskRun": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "build": [
- {
- "type": "string",
- "params": { },
- "def": { },
- "name": "string"
}
], - "selection": [
- {
- "id": "string",
- "entity": "string",
- "selector": "string",
- "description": "string"
}
], - "remediate": "string",
- "alert": "string",
- "type": "string",
- "version": "string",
- "displayName": "string"
}
]
}
RuleTypeService_CreateRuleType
Request Body schema: application/jsonrequired
CreateRuleTypeRequest is the request to create a rule type.
object (v1RuleType) RuleType defines rules that may or may not be user defined. The version is assumed from the folder's version. | |||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "ruleType": {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
}
Response samples
- 200
{- "ruleType": {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
}
RuleTypeService_UpdateRuleType
Request Body schema: application/jsonrequired
UpdateRuleTypeRequest is the request to update a rule type.
object (v1RuleType) RuleType defines rules that may or may not be user defined. The version is assumed from the folder's version. | |||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "ruleType": {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
}
Response samples
- 200
{- "ruleType": {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
}
RuleTypeService_GetRuleTypeByName
path Parameters
name required | string.+ name is the name of the rule type. |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "ruleType": {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
}
RuleTypeService_GetRuleTypeById
path Parameters
id required | string id is the id of the rule type. |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "ruleType": {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
}
RuleTypeService_DeleteRuleType
path Parameters
id required | string id is the id of the rule type to be deleted. |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{ }
RuleTypeService_ListRuleTypes
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "ruleTypes": [
- {
- "id": "string",
- "name": "string",
- "displayName": "string",
- "shortFailureMessage": "string",
- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "def": {
- "inEntity": "string",
- "ruleSchema": { },
- "paramSchema": { },
- "ingest": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "builtin": {
- "method": "string"
}, - "artifact": { },
- "git": {
- "cloneUrl": "string",
- "branch": "string"
}, - "diff": {
- "ecosystems": [
- {
- "name": "string",
- "depfile": "string"
}
], - "type": "string"
}
}, - "eval": {
- "type": "string",
- "jq": [
- {
- "ingested": {
- "def": "string"
}, - "profile": {
- "def": "string"
}, - "constant": null
}
], - "rego": {
- "type": "string",
- "def": "string",
- "violationFormat": "string"
}, - "vulncheck": { },
- "trusty": {
- "endpoint": "string"
}, - "homoglyphs": {
- "type": "string"
}
}, - "remediate": {
- "type": "string",
- "rest": {
- "endpoint": "string",
- "method": "string",
- "headers": [
- "string"
], - "body": "string",
- "parse": "string",
- "fallback": [
- {
- "httpCode": 0,
- "body": "string"
}
]
}, - "ghBranchProtection": {
- "patch": "string"
}, - "pullRequest": {
- "title": "string",
- "body": "string",
- "contents": [
- {
- "path": "string",
- "action": "string",
- "content": "string",
- "mode": "string"
}
], - "method": "string",
- "actionsReplaceTagsWithSha": {
- "exclude": [
- "string"
]
}
}
}, - "alert": {
- "type": "string",
- "securityAdvisory": {
- "severity": "string"
}
}
}, - "description": "string",
- "guidance": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
]
}
EvalResultsService_ListEvaluationHistory
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
entityType | Array of strings List of entity types to retrieve. |
entityName | Array of strings List of entity names to retrieve. |
profileName | Array of strings List of profile names to retrieve. |
status | Array of strings List of evaluation statuses to retrieve. |
remediation | Array of strings List of remediation statuses to retrieve. |
alert | Array of strings List of alert statuses to retrieve. |
from | string <date-time> Timestamp representing the start time of the selection window. |
to | string <date-time> Timestamp representing the end time of the selection window. |
cursor.cursor | string cursor is the index to start from within the collection being retrieved. It's an opaque payload specified and interpreted on an per-rpc basis. |
cursor.size | integer <int64> size is the number of items to retrieve from the collection. |
Responses
Response samples
- 200
{- "data": [
- {
- "entity": {
- "id": "string",
- "type": "ENTITY_UNSPECIFIED",
- "name": "string"
}, - "rule": {
- "name": "string",
- "ruleType": "string",
- "profile": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}
}, - "status": {
- "status": "string",
- "details": "string"
}, - "alert": {
- "status": "string",
- "details": "string"
}, - "remediation": {
- "status": "string",
- "details": "string"
}, - "evaluatedAt": "2019-08-24T14:15:22Z",
- "id": "string"
}
], - "page": {
- "totalRecords": 0,
- "next": {
- "cursor": "string",
- "size": 0
}, - "prev": {
- "cursor": "string",
- "size": 0
}
}
}
EvalResultsService_GetEvaluationHistory
path Parameters
id required | string |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "evaluation": {
- "entity": {
- "id": "string",
- "type": "ENTITY_UNSPECIFIED",
- "name": "string"
}, - "rule": {
- "name": "string",
- "ruleType": "string",
- "profile": "string",
- "severity": {
- "value": "VALUE_UNSPECIFIED"
}
}, - "status": {
- "status": "string",
- "details": "string"
}, - "alert": {
- "status": "string",
- "details": "string"
}, - "remediation": {
- "status": "string",
- "details": "string"
}, - "evaluatedAt": "2019-08-24T14:15:22Z",
- "id": "string"
}
}
EvalResultsService_ListEvaluationResults
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
profile | string ID can contain either a profile name or an ID |
labelFilter | string Filter profiles to only those matching the specified labels. The default is to return all user-created profiles; the string "*" can be used to select all profiles, including system profiles. This syntax may be expanded in the future. |
ruleName | Array of strings If set, only return evaluation results for the named rules. If empty, return evaluation results for all rules |
Responses
Response samples
- 200
{- "entities": [
- {
- "entity": {
- "type": "ENTITY_UNSPECIFIED",
- "id": "string"
}, - "profiles": [
- {
- "profileStatus": {
- "profileId": "string",
- "profileName": "string",
- "profileStatus": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "profileDisplayName": "string"
}, - "results": [
- {
- "profileId": "string",
- "ruleId": "string",
- "ruleName": "string",
- "entity": "string",
- "status": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "entityInfo": {
- "property1": "string",
- "property2": "string"
}, - "details": "string",
- "guidance": "string",
- "remediationStatus": "string",
- "remediationLastUpdated": "2019-08-24T14:15:22Z",
- "remediationDetails": "string",
- "ruleTypeName": "string",
- "ruleDescriptionName": "string",
- "alert": {
- "status": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "details": "string",
- "url": "string"
}, - "severity": {
- "value": "VALUE_UNSPECIFIED"
}, - "ruleEvaluationId": "string",
- "remediationUrl": "string",
- "ruleDisplayName": "string",
- "releasePhase": "RULE_TYPE_RELEASE_PHASE_UNSPECIFIED"
}
]
}
]
}
]
}
PermissionsService_AssignRole
Request Body schema: application/jsonrequired
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
object (v1RoleAssignment) |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "roleAssignment": {
- "role": "string",
- "subject": "string",
- "displayName": "string",
- "project": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string"
}
}
Response samples
- 200
{- "roleAssignment": {
- "role": "string",
- "subject": "string",
- "displayName": "string",
- "project": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string"
}, - "invitation": {
- "role": "string",
- "email": "string",
- "project": "string",
- "code": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "expired": true,
- "sponsor": "string",
- "sponsorDisplay": "string",
- "projectDisplay": "string",
- "inviteUrl": "string",
- "emailSkipped": true
}
}
PermissionsService_ListRoleAssignments
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "roleAssignments": [
- {
- "role": "string",
- "subject": "string",
- "displayName": "string",
- "project": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string"
}
], - "invitations": [
- {
- "role": "string",
- "email": "string",
- "project": "string",
- "code": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "expired": true,
- "sponsor": "string",
- "sponsorDisplay": "string",
- "projectDisplay": "string",
- "inviteUrl": "string",
- "emailSkipped": true
}
]
}
PermissionsService_RemoveRole
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
roleAssignment.role | string role is the role that is assigned. |
roleAssignment.subject | string subject is the subject to which the role is assigned. |
roleAssignment.displayName | string display_name is the display name of the subject. |
roleAssignment.project | string project is the project in which the role is assigned. |
roleAssignment.email | string email is the email address of the subject used for invitations. |
roleAssignment.firstName | string first_name is the first name of the subject. |
roleAssignment.lastName | string last_name is the last name of the subject. |
Responses
Response samples
- 200
{- "roleAssignment": {
- "role": "string",
- "subject": "string",
- "displayName": "string",
- "project": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string"
}, - "invitation": {
- "role": "string",
- "email": "string",
- "project": "string",
- "code": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "expired": true,
- "sponsor": "string",
- "sponsorDisplay": "string",
- "projectDisplay": "string",
- "inviteUrl": "string",
- "emailSkipped": true
}
}
PermissionsService_ListRoles
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "roles": [
- {
- "name": "string",
- "displayName": "string",
- "description": "string"
}
]
}
PermissionsService_UpdateRole
Request Body schema: application/jsonrequired
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
subject | string (subject is the account to change permissions for.
The account must already have permissions on the project) |
roles | Array of strings All subject roles are replaced with the following role assignments. Must be non-empty, use RemoveRole to remove permissions entirely from the project. |
string (email is the email address of the subject used for updating invitations) |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "subject": "string",
- "roles": [
- "string"
], - "email": "string"
}
Response samples
- 200
{- "roleAssignments": [
- {
- "role": "string",
- "subject": "string",
- "displayName": "string",
- "project": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string"
}
], - "invitations": [
- {
- "role": "string",
- "email": "string",
- "project": "string",
- "code": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "expired": true,
- "sponsor": "string",
- "sponsorDisplay": "string",
- "projectDisplay": "string",
- "inviteUrl": "string",
- "emailSkipped": true
}
]
}
ProjectsService_CreateProject
Request Body schema: application/jsonrequired
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
name | string name is the name of the project to create. |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "name": "string"
}
Response samples
- 200
{- "project": {
- "projectId": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "string"
}
}
ProjectsService_UpdateProject
Request Body schema: application/jsonrequired
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
displayName | string display_name is the display name of the project to update. |
description | string description is the description of the project to update. |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "displayName": "string",
- "description": "string"
}
Response samples
- 200
{- "project": {
- "projectId": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "string"
}
}
ProjectsService_PatchProject
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Request Body schema: application/jsonrequired
patch is the patch to apply to the project
displayName | string display_name is the display name of the project to update. |
description | string description is the description of the project to update. |
Responses
Request samples
- Payload
{- "displayName": "string",
- "description": "string"
}
Response samples
- 200
{- "project": {
- "projectId": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "string"
}
}
ProjectsService_CreateEntityReconciliationTask
Request Body schema: application/jsonrequired
object (v1EntityTypedId) EntiryTypeId is a message that carries an ID together with a type to uniquely identify an entity such as (repo, 1), (artifact, 2), ... | |
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. |
Responses
Request samples
- Payload
{- "entity": {
- "type": "ENTITY_UNSPECIFIED",
- "id": "string"
}, - "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}
}
Response samples
- 200
{ }
ProjectsService_ListChildProjects
path Parameters
context.projectId required | string project is the project ID |
query Parameters
context.provider | string name of the provider. Set to empty string when not applicable. |
recursive | boolean recursive is true if child projects should be listed recursively. |
Responses
Response samples
- 200
{- "projects": [
- {
- "projectId": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "string"
}
]
}
GetUnclaimedProviders returns a list of known provider configurations that this user could claim based on their identity. This is a read-only operation for use by clients which wish to present a menu of options.
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "providers": [
- {
- "githubApp": {
- "installationId": "string",
- "organization": "string",
- "organizationId": "string"
}
}
]
}
ProvidersService_ReconcileEntityRegistration
Request Body schema: application/jsonrequired
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
entity | string |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "entity": "string"
}
Response samples
- 200
{ }
ProvidersService_ListProviders
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
limit | integer <int32> limit is the maximum number of providers to return. |
cursor | string cursor is the cursor to use for the page of results, empty if at the beginning |
Responses
Response samples
- 200
{- "providers": [
- {
- "name": "string",
- "class": "string",
- "project": "string",
- "version": "string",
- "implements": [
- "PROVIDER_TYPE_UNSPECIFIED"
], - "config": { },
- "authFlows": [
- "AUTHORIZATION_FLOW_UNSPECIFIED"
], - "parameters": {
- "githubApp": {
- "installationId": "string",
- "organization": "string",
- "organizationId": "string"
}
}, - "credentialsState": "string"
}
], - "cursor": "string"
}
ProvidersService_CreateProvider
Request Body schema: application/jsonrequired
object (v1Context) Context defines the context in which a rule is evaluated. this normally refers to a combination of the provider, organization and project. Removing the 'optional' keyword from the following two fields below will break buf compatibility checks. | |
object (v1Provider) |
Responses
Request samples
- Payload
{- "context": {
- "provider": "string",
- "project": "string",
- "retiredOrganization": "string"
}, - "provider": {
- "name": "string",
- "class": "string",
- "project": "string",
- "version": "string",
- "implements": [
- "PROVIDER_TYPE_UNSPECIFIED"
], - "config": { },
- "authFlows": [
- "AUTHORIZATION_FLOW_UNSPECIFIED"
], - "parameters": {
- "githubApp": {
- "installationId": "string",
- "organization": "string",
- "organizationId": "string"
}
}, - "credentialsState": "string"
}
}
Response samples
- 200
{- "provider": {
- "name": "string",
- "class": "string",
- "project": "string",
- "version": "string",
- "implements": [
- "PROVIDER_TYPE_UNSPECIFIED"
], - "config": { },
- "authFlows": [
- "AUTHORIZATION_FLOW_UNSPECIFIED"
], - "parameters": {
- "githubApp": {
- "installationId": "string",
- "organization": "string",
- "organizationId": "string"
}
}, - "credentialsState": "string"
}, - "authorization": {
- "authorizationUrl": "string"
}
}
ProvidersService_PatchProvider
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Request Body schema: application/jsonrequired
name | string name is the name of the provider. |
class | string class is the name of the provider implementation, eg. 'github' or 'gh-app'. |
project | string project is the project where the provider is. This is ignored on input in favor of the context field in CreateProviderRequest. |
version | string version is the version of the provider. |
implements | Array of strings (v1ProviderType) Items Enum: "PROVIDER_TYPE_UNSPECIFIED" "PROVIDER_TYPE_GITHUB" "PROVIDER_TYPE_REST" "PROVIDER_TYPE_GIT" "PROVIDER_TYPE_OCI" "PROVIDER_TYPE_REPO_LISTER" "PROVIDER_TYPE_IMAGE_LISTER" implements is the list of interfaces that the provider implements. |
config | object config is the configuration of the provider. |
authFlows | Array of strings (v1AuthorizationFlow) Items Enum: "AUTHORIZATION_FLOW_UNSPECIFIED" "AUTHORIZATION_FLOW_NONE" "AUTHORIZATION_FLOW_USER_INPUT" "AUTHORIZATION_FLOW_OAUTH2_AUTHORIZATION_CODE_FLOW" "AUTHORIZATION_FLOW_GITHUB_APP_FLOW" auth_flows is the list of authorization flows that the provider supports. |
object (v1ProviderParameter) | |
credentialsState | string credentials_state is the state of the credentials for the provider. This is an output-only field. It may be: "set", "unset", "not_applicable". |
Responses
Request samples
- Payload
{- "name": "string",
- "class": "string",
- "project": "string",
- "version": "string",
- "implements": [
- "PROVIDER_TYPE_UNSPECIFIED"
], - "config": { },
- "authFlows": [
- "AUTHORIZATION_FLOW_UNSPECIFIED"
], - "parameters": {
- "githubApp": {
- "installationId": "string",
- "organization": "string",
- "organizationId": "string"
}
}, - "credentialsState": "string"
}
Response samples
- 200
{- "provider": {
- "name": "string",
- "class": "string",
- "project": "string",
- "version": "string",
- "implements": [
- "PROVIDER_TYPE_UNSPECIFIED"
], - "config": { },
- "authFlows": [
- "AUTHORIZATION_FLOW_UNSPECIFIED"
], - "parameters": {
- "githubApp": {
- "installationId": "string",
- "organization": "string",
- "organizationId": "string"
}
}, - "credentialsState": "string"
}
}
ProvidersService_DeleteProviderByID
path Parameters
id required | string id is the id of the provider to delete |
query Parameters
context.provider | string name of the provider |
context.project | string ID of the project |
context.retiredOrganization | string |
Responses
Response samples
- 200
{- "id": "string"
}