Skip to main content
PUT
/
v2
/
access-profiles
/
{id}
Update Access Profile
curl --request PUT \
  --url https://public.api.serval.com/v2/access-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "matchingCriteria": {
    "groups": {
      "matchType": "ACCESS_PROFILE_GROUP_MATCH_TYPE_UNSPECIFIED",
      "includedGroupIds": [
        "<string>"
      ],
      "excludedGroupIds": [
        "<string>"
      ]
    }
  },
  "grants": {
    "appResourceRoles": [
      {
        "appResourceRoleId": "<string>"
      }
    ],
    "workflows": [
      {
        "workflowId": "<string>"
      }
    ]
  }
}
'
{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "isTeamDefault": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "matchingCriteria": {
      "groups": {
        "matchType": "ACCESS_PROFILE_GROUP_MATCH_TYPE_UNSPECIFIED",
        "includedGroupIds": [
          "<string>"
        ],
        "excludedGroupIds": [
          "<string>"
        ]
      }
    },
    "grants": {
      "appResourceRoles": [
        {
          "appResourceRoleId": "<string>",
          "useTeamDefaultAccessProfile": true
        }
      ],
      "workflows": [
        {
          "workflowId": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the access profile to update.

Body

application/json
name
string

Updated name.

description
string | null

Updated description. Omit to leave unchanged; set to "" to clear.

matchingCriteria
matching_criteria · object

The rules that determine which users this profile applies to (replace-all semantics).

grants
grants · object

The grants provided by this profile (replace-all semantics).

Response

Success

data
data · object

An access profile defines which entitlements are available to which groups of users, and which workflows apply.