StackSpot IAM - Scim Provider API (1.0)
Download OpenAPI specification:Download
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create Action
Create a new action
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Action
client_id | string |
description | string |
name required | string |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string"
}
Response samples
- 201
{- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Update Actions
Update Actions
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Action
client_id | string |
description | string |
name required | string |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string"
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Patch Operation Action
Patch Operation Action
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Action
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "Operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "client_id": "string",
- "description": "string",
- "name": "string"
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "displayName": "string",
- "members": [
- {
- "$ref": "string",
- "display": "string",
- "type": "string",
- "value": "string"
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create Group
Create a new group
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Group
displayName required | string |
Responses
Request samples
- Payload
{- "displayName": "string"
}
Response samples
- 201
{- "attributes": {
- "displayName": "string",
- "members": [
- {
- "$ref": "string",
- "display": "string",
- "type": "string",
- "value": "string"
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "attributes": {
- "displayName": "string",
- "members": [
- {
- "$ref": "string",
- "display": "string",
- "type": "string",
- "value": "string"
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Update Groups
Update Groups
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Group
displayName | string |
Responses
Request samples
- Payload
{- "displayName": "string"
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "displayName": "string",
- "members": [
- {
- "$ref": "string",
- "display": "string",
- "type": "string",
- "value": "string"
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Patch Operation Group
Patch Operation Group
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Group
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "Operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "members": [
- {
- "$ref": "string",
- "display": "string",
- "type": "string",
- "value": "string"
}
]
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "displayName": "string",
- "members": [
- {
- "$ref": "string",
- "display": "string",
- "type": "string",
- "value": "string"
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
GetAll Permissions
GetAll Permissions
header Parameters
Authorization required | string Bearer token |
Responses
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- null
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create Permission
Create a new permission
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Permission
client_id | string |
description | string |
name required | string |
required | Array of objects |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- "string"
], - "resource": "string"
}
]
}
Response samples
- 201
{- "attributes": {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Update Permissions
Update Permissions
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Permission
client_id | string |
description | string |
name required | string |
Array of objects |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string",
- "statements": [
- {
- "action": "string",
- "resource": "string"
}
]
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- null
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Patch Operation Permission
Patch Operation Permission
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Permission
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "Operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "statements": [
- {
- "action": "string",
- "resource": "string"
}
]
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Get Permission
Get permission by id
header Parameters
Authorization required | string Bearer token |
Responses
Response samples
- 200
{- "attributes": {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
GetAll Resource-Type
Getall resource-types
header Parameters
Authorization required | string Bearer token |
Responses
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "description": "string",
- "name": "string",
- "resources": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
], - "slug": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create Resource-Type
Create a new resource-type
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Resource
actions required | Array of strings |
client_id | string |
description | string |
name required | string |
slug | string |
Responses
Request samples
- Payload
{- "actions": [
- "string"
], - "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string"
}
Response samples
- 201
{- "attributes": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "description": "string",
- "name": "string",
- "resources": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
], - "slug": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Get Resource-Type
Get resource-type by id
header Parameters
Authorization required | string Bearer token |
Responses
Response samples
- 200
{- "attributes": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "description": "string",
- "name": "string",
- "resources": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
], - "slug": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Replace Resource-Type
Replace resource-types
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Resource
client_id | string |
description | string |
name required | string |
slug required | string |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string"
}
Response samples
- 200
{- "attributes": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "description": "string",
- "name": "string",
- "resources": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
], - "slug": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Patch Operation Resource-Type
Patch Operation resource-types
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Resource
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string"
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "description": "string",
- "name": "string",
- "resources": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
], - "slug": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create Resource
Create a new resource
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Resource
client_id | string |
description | string |
name required | string |
slug | string |
type required | string |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": "string"
}
Response samples
- 201
{- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Replace Resource
Replace resource
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Resource
client_id | string |
description | string |
name required | string |
slug required | string |
type required | string |
Responses
Request samples
- Payload
{- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": "string"
}
Response samples
- 200
{- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Patch Operation Resource
Patch Operation a new resource
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Resource
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "Operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": "string"
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": null,
- "externalID": { },
- "id": null,
- "meta": null,
- "schemas": [ ]
}
], - "resource": {
- "attributes": {
- "client_id": null,
- "description": null,
- "name": null,
- "slug": null,
- "type": { }
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": null,
- "lastModified": null,
- "location": null,
- "resourceType": null,
- "version": null
}, - "schemas": [
- null
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create Role
Create a new role
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create Role
object | |
client_id | string |
description | string |
id | string |
name required | string |
permissions | Array of strings |
Array of objects |
Responses
Request samples
- Payload
{- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "permissions": [
- "string"
], - "statements": [
- {
- "actions": [
- "string"
], - "resource": "string"
}
]
}
Response samples
- 201
{- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- null
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Update Roles
Update Roles
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Role
object | |
client_id | string |
description | string |
name required | string |
permissions | Array of strings |
Responses
Request samples
- Payload
{- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "description": "string",
- "name": "string",
- "permissions": [
- "string"
]
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": null,
- "externalID": { },
- "id": null,
- "meta": null,
- "schemas": [ ]
}
], - "resource": {
- "attributes": {
- "client_id": null,
- "description": null,
- "name": null,
- "slug": null,
- "type": { }
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": null,
- "lastModified": null,
- "location": null,
- "resourceType": null,
- "version": null
}, - "schemas": [
- null
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Patch Operation Role
Patch Operation Role
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update Role
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "Operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "description": "string",
- "name": "string",
- "permissions": [
- "string"
]
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- null
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": {
- "active": true,
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "resource": {
- "attributes": {
- "client_id": "string",
- "description": "string",
- "name": "string",
- "slug": "string",
- "type": {
- "actions": [
- null
], - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "slug": "string"
}
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": null,
- "externalID": { },
- "id": null,
- "meta": null,
- "schemas": [ ]
}
], - "resource": {
- "attributes": {
- "client_id": null,
- "description": null,
- "name": null,
- "slug": null,
- "type": { }
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": null,
- "lastModified": null,
- "location": null,
- "resourceType": null,
- "version": null
}, - "schemas": [
- null
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Create User
Create a new user
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Create User
active | boolean |
displayName | string |
Array of objects | |
locale | string |
object | |
nickName | string |
password | string |
Array of objects | |
preferredLanguage | string |
profileUrl | string |
timezone | string |
title | string |
object | |
userName | string |
userType | string |
Responses
Request samples
- Payload
{- "active": true,
- "displayName": "string",
- "emails": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "locale": "string",
- "name": {
- "familyName": "string",
- "givenName": "string"
}, - "nickName": "string",
- "password": "string",
- "phoneNumbers": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "preferredLanguage": "string",
- "profileUrl": "string",
- "timezone": "string",
- "title": "string",
- "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
- "blocked": true,
- "company": "string",
- "ddd": "string",
- "ddi": "string",
- "gender": "string",
- "generatePassword": true,
- "hireDate": "string",
- "human": true,
- "is_email_verified": true,
- "machineName": "string",
- "preferredLoginName": "string",
- "properties": { },
- "resourceOwner": "string"
}, - "userName": "string",
- "userType": "string"
}
Response samples
- 201
{- "attributes": {
- "active": true,
- "displayName": "string",
- "emails": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "locale": "string",
- "name": {
- "familyName": "string",
- "givenName": "string"
}, - "nickName": "string",
- "password": "string",
- "phoneNumbers": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "preferredLanguage": "string",
- "profileUrl": "string",
- "timezone": "string",
- "title": "string",
- "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
- "blocked": true,
- "company": "string",
- "ddd": "string",
- "ddi": "string",
- "gender": "string",
- "generatePassword": true,
- "hireDate": "string",
- "human": true,
- "is_email_verified": true,
- "machineName": "string",
- "preferredLoginName": "string",
- "properties": { },
- "resourceOwner": "string"
}, - "userName": "string",
- "userType": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Update Users
Update Users
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update User
Array of objects | |
object | |
Array of objects | |
object | |
userName | string |
Responses
Request samples
- Payload
{- "emails": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "name": {
- "familyName": "string",
- "givenName": "string"
}, - "phoneNumbers": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
- "company": "string",
- "ddd": "string",
- "ddi": "string",
- "hireDate": "string",
- "is_email_verified": true
}, - "userName": "string"
}
Response samples
- 200
{- "resources": [
- {
- "attributes": {
- "claim_mapper": {
- "property1": "string",
- "property2": "string"
}, - "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "member_count": 0,
- "name": "string",
- "permissions": [
- {
- "client_id": "string",
- "created_at": "string",
- "description": "string",
- "id": "string",
- "name": "string",
- "statements": [
- {
- "actions": [
- {
- "attributes": null,
- "externalID": { },
- "id": null,
- "meta": null,
- "schemas": [ ]
}
], - "resource": {
- "attributes": {
- "client_id": null,
- "description": null,
- "name": null,
- "slug": null,
- "type": { }
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": null,
- "lastModified": null,
- "location": null,
- "resourceType": null,
- "version": null
}, - "schemas": [
- null
]
}
}
]
}
]
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
], - "totalResults": 0
}
Patch Operation User
Patch Operation User
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/jsonrequired
Update User
Array of objects | |
schemas | string |
Responses
Request samples
- Payload
{- "Operations": [
- {
- "op": "string",
- "path": {
- "attributePath": {
- "attributeName": "string",
- "subAttribute": "string",
- "uriprefix": "string"
}, - "subAttribute": "string",
- "valueExpression": null
}, - "value": {
- "emails": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "name": {
- "familyName": "string",
- "givenName": "string"
}, - "phoneNumbers": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
- "company": "string",
- "ddd": "string",
- "ddi": "string",
- "hireDate": "string",
- "is_email_verified": true
}, - "userName": "string"
}
}
], - "schemas": "string"
}
Response samples
- 200
{- "attributes": {
- "active": true,
- "displayName": "string",
- "emails": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "locale": "string",
- "name": {
- "familyName": "string",
- "givenName": "string"
}, - "nickName": "string",
- "password": "string",
- "phoneNumbers": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "preferredLanguage": "string",
- "profileUrl": "string",
- "timezone": "string",
- "title": "string",
- "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
- "blocked": true,
- "company": "string",
- "ddd": "string",
- "ddi": "string",
- "gender": "string",
- "generatePassword": true,
- "hireDate": "string",
- "human": true,
- "is_email_verified": true,
- "machineName": "string",
- "preferredLoginName": "string",
- "properties": { },
- "resourceOwner": "string"
}, - "userName": "string",
- "userType": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}
Response samples
- 200
{- "attributes": {
- "active": true,
- "displayName": "string",
- "emails": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "locale": "string",
- "name": {
- "familyName": "string",
- "givenName": "string"
}, - "nickName": "string",
- "password": "string",
- "phoneNumbers": [
- {
- "primary": true,
- "type": "string",
- "value": "string"
}
], - "preferredLanguage": "string",
- "profileUrl": "string",
- "timezone": "string",
- "title": "string",
- "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
- "blocked": true,
- "company": "string",
- "ddd": "string",
- "ddi": "string",
- "gender": "string",
- "generatePassword": true,
- "hireDate": "string",
- "human": true,
- "is_email_verified": true,
- "machineName": "string",
- "preferredLoginName": "string",
- "properties": { },
- "resourceOwner": "string"
}, - "userName": "string",
- "userType": "string"
}, - "externalID": { },
- "id": "string",
- "meta": {
- "created": "string",
- "lastModified": "string",
- "location": "string",
- "resourceType": "string",
- "version": "string"
}, - "schemas": [
- "string"
]
}