Absorb SCIM API (v2)
Download OpenAPI specification:Download
List Schemas.
Responses
Response Schema: application/json
| schemas | Array of strings The response schemas. |
| totalResults | integer <int32> The total number of results returned. |
| startIndex | integer <int32> The 1-based index of the first result in the current set of search results. |
| itemsPerPage | integer <int32> The number of results returned on a page. |
Array of objects (SchemaResponse) The list of returned resources. |
Response samples
- 200
- 400
- 403
Content type
application/json
{- "schemas": [
- "string"
], - "totalResults": 0,
- "startIndex": 0,
- "itemsPerPage": 0,
- "Resources": [
- {
- "schemas": [
- "string"
], - "id": "string",
- "name": "string",
- "description": "string",
- "attributes": [
- {
- "name": "string",
- "type": "string",
- "referenceTypes": [
- "string"
], - "multiValued": true,
- "description": "string",
- "required": true,
- "caseExact": true,
- "mutability": "string",
- "uniqueness": "string",
- "returned": "string",
- "subAttributes": [
- { }
]
}
]
}
]
}Get schema by schema URN.
path Parameters
| schemaId required | string Schema's URN |
query Parameters
| attributes | Array of strings The list of attributes to include in the response. |
| excludedAttributes | Array of strings The list of attributes to exclude from the response. |
Responses
Response Schema: application/json
| schemas | Array of strings The Schemas. |
| id | string The unique URI of the schema. |
| name | string The schema's human-readable name. |
| description | string The schema's human-readable description. |
Array of objects (SchemaPropertyResponse) An array of attributes that define service provider attributes and their qualities. |
Response samples
- 200
- 400
- 404
Content type
application/json
{- "schemas": [
- "string"
], - "id": "string",
- "name": "string",
- "description": "string",
- "attributes": [
- {
- "name": "string",
- "type": "string",
- "referenceTypes": [
- "string"
], - "multiValued": true,
- "description": "string",
- "required": true,
- "caseExact": true,
- "mutability": "string",
- "uniqueness": "string",
- "returned": "string",
- "subAttributes": [
- { }
]
}
]
}