Skip to content
vocapable.Docs

Map an identity-provider group onto a queue or a skill (applied at once)

POST
/v1/workspace/scim/group-mappings
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/scim/group-mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "team_id": "example", "target_kind": "queue", "queue_id": "example", "skill_id": "example", "proficiency": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceScimGroupMappingCreate
object
team_id
required
Team Id
string
>= 1 characters <= 64 characters
target_kind
required
Target Kind
string
Allowed values: queue skill
queue_id
Any of:
string
<= 64 characters
skill_id
Any of:
string
<= 64 characters
proficiency
Any of:
integer
>= 1 <= 5

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceScimGroupMappings
object
mappings
required
Mappings
Array<object>
WorkspaceScimGroupMapping

CC7-R5: an identity-provider group (mirrored as a team) also grants a queue membership or a skill to everyone in it, and takes it back when they leave.

object
id
required
Id
string
team_id
required
Team Id
string
team_name
required
Team Name
string
target_kind
required
Target Kind
string
Allowed values: queue skill
queue_id
required
Any of:
string
skill_id
required
Any of:
string
target_name
required
Target Name
string
proficiency
required
Any of:
integer
granted
required
Granted
integer
created_at
required
Created At
string format: date-time
Example
{
  "mappings": [
    {
      "target_kind": "queue"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}