Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Scim API

Provisioning of GitHub organization membership for SCIM-enabled providers.

This API exposes 13 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

13 operations 7 paths 9 schemas 1 DELETE7 GET2 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Scim API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 2 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Scim 13

Provisioning of GitHub organization membership for SCIM-enabled providers.

GET
/scim/v2/enterprises/{enterprise}/Groups
APIs.io Engineering Platform List provisioned SCIM groups for an enterprise
enterprise-admin/list-provisioned-groups-enterprise 5 params → 200400401403429500
GET
/scim/v2/Groups
APIs.io Engineering Platform Get all group resources
getScimGroupResources 3 params → 200400401403500
POST
/scim/v2/Groups
APIs.io Engineering Platform Create a group
createScimGroup body → 201400401403409500
GET
/scim/v2/Groups/{groupId}
APIs.io Engineering Platform Get a group resource
getScimGroupResource 1 param → 200400401403404500
PATCH
/scim/v2/Groups/{groupId}
APIs.io Engineering Platform Update a group
scimUpdateGroup 1 param body → 200400401403404500
DELETE
/scim/v2/Groups/{groupId}
APIs.io Engineering Platform Delete a group
deleteScimGroup 1 param → 204400401403404500
GET
/scim/v2/ResourceTypes
APIs.io Engineering Platform Get resource types
getScimResourceTypes → 200401500
GET
/scim/v2/ServiceProviderConfig
APIs.io Engineering Platform Get service provider configuration
getScimServiceProviderConfig → 200401500
GET
/scim/v2/Users
APIs.io Engineering Platform Get all user resources
getScimUserResources 3 params → 200400401403500
POST
/scim/v2/Users
APIs.io Engineering Platform Create a user
createScimUser body → 201400401403409500
GET
/scim/v2/Users/{userId}
APIs.io Engineering Platform Get a user resource
getScimUserResource 1 param → 200400401403404500
PUT
/scim/v2/Users/{userId}
APIs.io Engineering Platform Update a user
updateScimUser 1 param body → 200400401403404500
PATCH
/scim/v2/Users/{userId}
APIs.io Engineering Platform Update a user's state
updateScimUserState 1 param body → 200400401403404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are scimUserResource (7 properties), scimGroupResource (6 properties), scim-error (6 properties), scimUserResources (5 properties). Each schema is shown below with its type and property counts.

scimGroupResource
object
The SCIM group resource object.
6 properties
scim-enterprise-group-response
scimId
string
scimUserResources
object
5 properties
scim-error
object
Scim Error
6 properties
meta
object
The metadata associated with the creation/updates to the user.
4 properties 1 required
scimUserResource
object
The SCIM user resource object.
7 properties
scim-enterprise-group-list
object
5 properties 5 required
group-response
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-scim-api-openapi.yml Raw ↑