Skip to Content
kosemdocs
ReferenceAPIAccess profiles

Update access profile in project

Updates an access profile's alias, description, config, or organization sharing.

PATCH
/v1/projects/{project}/accessProfiles/{accessProfile}

Updates an access profile's alias, description, config, or organization sharing.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

project*string

The project's ID.

Match^prj_[0-7][0-9a-hjkmnp-tv-z]{25}$
accessProfile*string

The access profile's ID.

Match^acp_[0-7][0-9a-hjkmnp-tv-z]{25}$

Request Body

application/json
  1. body
alias?string

New alias.

Match^[a-z][a-z0-9_]*(/[a-z0-9_]+)*$
Length1 <= length <= 128
availability?

For an organization access profile: updated project sharing. Takes connections.accessProfiles.setAvailability.

config?

Replacement provider-specific ceiling scope. Takes connections.connections.use on the backing connection.

description?string

New description.

Lengthlength <= 500
etag?string

Expected etag for optimistic concurrency.

Response Body

OK

application/json
  1. response
alias*string

Short name unique within its organization or project, such as github/kosem or gcp/preview_viewer.

availability*

For an organization's access profile: projects it is shared with. Shared profiles materialize read-only project copies automatically.

config*

Provider-specific ceiling scope for issued credentials.

connection*string

Resource name of the backing connection.

createTime*string

When the access profile was created.

Formatdate-time
description*string

What this access profile is for.

etag*string

Opaque revision tag for optimistic concurrency on updates.

name*string

Resource name: organizations/{organization_id}/accessProfiles/{profile_id} or projects/{project_id}/accessProfiles/{profile_id}.

provider*string

Provider type, such as providers/github, providers/google-cloud or providers/aws.

source?string

For a shared project copy: resource name of the organization access profile it mirrors.

state*string

Whether credentials can be issued through this profile.

Value in"ACTIVE""NEEDS_ATTENTION"
stateReason*string

Why the profile needs attention.

updateTime*string

When the access profile was last updated.

Formatdate-time
Example Request
curl -X PATCH 'https://api.kosem.ai/v1/projects/string/accessProfiles/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "alias": "string",
  "availability": {
    "allProjects": true,
    "projects": [
      "string"
    ]
  },
  "config": {
    "property1": null,
    "property2": null
  },
  "connection": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "description": "string",
  "etag": "string",
  "name": "string",
  "provider": "string",
  "source": "string",
  "state": "ACTIVE",
  "stateReason": "string",
  "updateTime": "2019-08-24T14:15:22Z"
}