Generated by Openapi Generator https://github.com/openapitools/openapi-generator
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: v0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Table of Contents

AdminRest

Bulk

EntitlementRest

Entitlements

Groups

JwksRest

ListRest

Me

OrgAndRegistrationRest

ResourceTypes

Roles

SchemaRest

Schemas

ServiceProviderConfig

SoDRest

Users

AdminRest

Up 
put /admin/Applications/{appId}/Policies/{versionId}/approve
(approveApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body string (required)
Body Parameter —

Responses

200

OK
Up 
post /admin/ApiKeys
(createApiKey)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ApiKey ApiKey (required)
Body Parameter —

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK String
Up 
post /admin/Applications
(createApplication)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Application Application (required)
Body Parameter —

Responses

200

OK
Up 
post /admin/Applications/{appId}/Policydrafts
(createApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

VersionAndPolicy VersionAndPolicy (required)
Body Parameter —

Responses

200

OK
Up 
post /admin/Applications/{appId}/Policies
(createApplicationPolicyAndSubmit)

Path parameters

appId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

VersionAndPolicy VersionAndPolicy (required)
Body Parameter —

Responses

200

OK
Up 
delete /admin/ApiKeys/{id}
(deleteApiKey)

Path parameters

id (required)
Path Parameter — default: null

Responses

200

OK
Up 
delete /admin/Applications/{appId}
(deleteApplication)

Path parameters

appId (required)
Path Parameter — default: null

Responses

200

OK
Up 
delete /admin/Applications/{appId}/Policies/{versionId}
(deletePolicyVersion)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Responses

200

OK
Up 
put /admin/Applications/{appId}/Policies/{versionId}/deny
(denyApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body string (required)
Body Parameter —

Responses

200

OK
Up 
put /admin/Applications/{appId}/Policies/{versionId}/deploy
(deployApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body string (required)
Body Parameter —

Responses

200

OK
Up 
get /admin/ApiKeys/{id}
(getApiKey)

Path parameters

id (required)
Path Parameter — default: null

Return type

AuthorizedEntityApiKey

Example data

Content-Type: application/json 
{
  "authorizedActions" : [ "authorizedActions", "authorizedActions" ],
  "entity" : {
    "owner" : "owner",
    "expTime" : 0,
    "name" : "name",
    "id" : "id",
    "orgId" : "orgId"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK AuthorizedEntityApiKey
Up 
get /admin/Applications/{appId}
(getApplication)

Path parameters

appId (required)
Path Parameter — default: null

Return type

AuthorizedEntityApplication

Example data

Content-Type: application/json 
{
  "authorizedActions" : [ "authorizedActions", "authorizedActions" ],
  "entity" : {
    "name" : "name",
    "description" : "description",
    "id" : "id",
    "updatedOn" : 0,
    "orgId" : "orgId"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK AuthorizedEntityApplication
Up 
get /admin/Applications/{appId}/policyversions
(getApplicationVersions)

Path parameters

appId (required)
Path Parameter — default: null

Return type

array[AuthorizedEntityVersionInfo]

Example data

Content-Type: application/json 
[ {
  "authorizedActions" : [ "authorizedActions", "authorizedActions" ],
  "entity" : {
    "lastUpdatedBy" : "lastUpdatedBy",
    "note" : "note",
    "approvedBy" : "approvedBy",
    "deployedBy" : "deployedBy",
    "label" : "label",
    "updatedOn" : 6,
    "version" : 0,
    "orgId" : "orgId",
    "approvedOn" : "2000-01-23T04:56:07.000+00:00",
    "deployedOn" : "2000-01-23T04:56:07.000+00:00",
    "undeployedOn" : "2000-01-23T04:56:07.000+00:00",
    "policyId" : "policyId",
    "lastUpdatedOn" : "2000-01-23T04:56:07.000+00:00",
    "undeployedBy" : "undeployedBy",
    "id" : "id",
    "applicationId" : "applicationId",
    "desc" : "desc",
    "status" : "status"
  }
}, {
  "authorizedActions" : [ "authorizedActions", "authorizedActions" ],
  "entity" : {
    "lastUpdatedBy" : "lastUpdatedBy",
    "note" : "note",
    "approvedBy" : "approvedBy",
    "deployedBy" : "deployedBy",
    "label" : "label",
    "updatedOn" : 6,
    "version" : 0,
    "orgId" : "orgId",
    "approvedOn" : "2000-01-23T04:56:07.000+00:00",
    "deployedOn" : "2000-01-23T04:56:07.000+00:00",
    "undeployedOn" : "2000-01-23T04:56:07.000+00:00",
    "policyId" : "policyId",
    "lastUpdatedOn" : "2000-01-23T04:56:07.000+00:00",
    "undeployedBy" : "undeployedBy",
    "id" : "id",
    "applicationId" : "applicationId",
    "desc" : "desc",
    "status" : "status"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK
Up 
get /admin/Applications/{appId}/resmap
(getCurrentPolicyResourceTree)

Path parameters

appId (required)
Path Parameter — default: null

Return type

map[String, set[String]]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK
Up 
get /admin/grouprole/{id}
(getGroupRoleMembershipWithSchema)

Path parameters

id (required)
Path Parameter — default: null

Return type

MembershipWithSchema

Example data

Content-Type: application/json 
{
  "schema" : {
    "jsonSchema" : "jsonSchema",
    "uiSchema" : "uiSchema"
  },
  "membership" : {
    "key" : "{}"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK MembershipWithSchema
Up 
get /admin/Applications/{appId}/Policies/{versionId}
(getPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Return type

AuthorizedEntityVersionAndPolicy

Example data

Content-Type: application/json 
{
  "authorizedActions" : [ "authorizedActions", "authorizedActions" ],
  "entity" : {
    "applicationPolicy" : {
      "policyRecords" : [ {
        "note" : "note",
        "condition" : "condition",
        "functionalCondition" : "functionalCondition",
        "subjects" : "subjects",
        "obligations" : "obligations",
        "resources" : "resources",
        "denyPolicy" : true,
        "actions" : "actions"
      }, {
        "note" : "note",
        "condition" : "condition",
        "functionalCondition" : "functionalCondition",
        "subjects" : "subjects",
        "obligations" : "obligations",
        "resources" : "resources",
        "denyPolicy" : true,
        "actions" : "actions"
      } ],
      "id" : "id",
      "orgId" : "orgId"
    },
    "versionInfo" : {
      "lastUpdatedBy" : "lastUpdatedBy",
      "note" : "note",
      "approvedBy" : "approvedBy",
      "deployedBy" : "deployedBy",
      "label" : "label",
      "updatedOn" : 6,
      "version" : 0,
      "orgId" : "orgId",
      "approvedOn" : "2000-01-23T04:56:07.000+00:00",
      "deployedOn" : "2000-01-23T04:56:07.000+00:00",
      "undeployedOn" : "2000-01-23T04:56:07.000+00:00",
      "policyId" : "policyId",
      "lastUpdatedOn" : "2000-01-23T04:56:07.000+00:00",
      "undeployedBy" : "undeployedBy",
      "id" : "id",
      "applicationId" : "applicationId",
      "desc" : "desc",
      "status" : "status"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK AuthorizedEntityVersionAndPolicy
Up 
get /admin/userrole/{id}
(getUserRoleMembershipWithSchema)

Path parameters

id (required)
Path Parameter — default: null

Return type

MembershipWithSchema

Example data

Content-Type: application/json 
{
  "schema" : {
    "jsonSchema" : "jsonSchema",
    "uiSchema" : "uiSchema"
  },
  "membership" : {
    "key" : "{}"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK MembershipWithSchema
Up 
post /admin/queryFunctional
(queryFunctional)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

QueryFunctionalRequest QueryFunctionalRequest (required)
Body Parameter —

Return type

set[ResourceAction]

Example data

Content-Type: */*
[ {
  "resource" : "resource",
  "action" : "action"
}, {
  "resource" : "resource",
  "action" : "action"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK
Up 
put /admin/Applications/{appId}/Policies/{versionId}
(submitApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

VersionAndPolicy VersionAndPolicy (required)
Body Parameter —

Responses

200

OK
Up 
put /admin/Applications/{appId}/Policies/{versionId}/undeploy
(undeployApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body string (required)
Body Parameter —

Responses

200

OK
Up 
put /admin/ApiKeys/{id}
(updateApiKey)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ApiKey ApiKey (required)
Body Parameter —

Responses

200

OK
Up 
put /admin/Applications/{appId}
(updateApplication)

Path parameters

appId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Application Application (required)
Body Parameter —

Responses

200

OK
Up 
put /admin/Applications/{appId}/Policydrafts/{versionId}
(updateApplicationPolicy)

Path parameters

appId (required)
Path Parameter — default: null
versionId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

VersionAndPolicy VersionAndPolicy (required)
Body Parameter —

Responses

200

OK

Bulk

Up 
post /scim/v2/Bulk
(bulkPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

BulkRequest BulkRequest (optional)
Body Parameter —

Return type

BulkResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

201

Valid user is created BulkResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

409

Object already exists BulkResponse

EntitlementRest

Up 
post /entitlement/checkaccess
(checkAccess)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

EntitlementRequest EntitlementRequest (required)
Body Parameter —

Return type

CheckAccessResponse

Example data

Content-Type: application/json 
{
  "obligations" : {
    "key" : [ "{}", "{}" ]
  },
  "granted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK CheckAccessResponse
Up 
post /entitlement/getfilter
(getFilter)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

EntitlementRequest EntitlementRequest (required)
Body Parameter —

Return type

FilterResponse

Example data

Content-Type: application/json 
{
  "filterObject" : "{}",
  "granted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK FilterResponse
Up 
post /entitlement/queryaction
(queryAction)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

QueryRequest QueryRequest (required)
Body Parameter —

Return type

QueryActionResponse

Example data

Content-Type: application/json 
{
  "actions" : [ "actions", "actions" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK QueryActionResponse
Up 
post /entitlement/queryfunctional
(queryFunctionalAccess)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

EntitlementRequest EntitlementRequest (required)
Body Parameter —

Return type

QueryFunctionalAccessResponse

Example data

Content-Type: application/json 
{
  "functionalAccess" : [ {
    "resource" : "resource",
    "action" : "action"
  }, {
    "resource" : "resource",
    "action" : "action"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK QueryFunctionalAccessResponse
Up 
post /entitlement/queryuser
(queryUser)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

EntitlementRequest EntitlementRequest (required)
Body Parameter —

Return type

QueryUserResponse

Example data

Content-Type: application/json 
{
  "users" : [ "users", "users" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK QueryUserResponse

Entitlements

Up 
get /scim/v2/Entitlements
(entitlementsGet)

Query parameters

filter (optional)
Query Parameter — Filter expression default: null
attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null
startIndex (optional)
Query Parameter — Pagination start index default: null format: int32
count (optional)
Query Parameter — Pagination page size default: null format: int32

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid entitlements are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
delete /scim/v2/Entitlements/{id}
(entitlementsIdDelete)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

204

Entitlement is deleted

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
get /scim/v2/Entitlements/{id}
(entitlementsIdGet)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid entitlement is found String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
patch /scim/v2/Entitlements/{id}
(entitlementsIdPatch)

Path parameters

id (required)
Path Parameter — Unique id of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

PatchRequest PatchRequest (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Entitlement is updated String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

406

Not Acceptable ErrorNotAcceptable
Up 
put /scim/v2/Entitlements/{id}
(entitlementsIdPut)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Entitlement is updated String

400

Invalid Input ErrorInvalidInput

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

406

Not Acceptable ErrorNotAcceptable
Up 
post /scim/v2/Entitlements
(entitlementsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

201

Valid entitlement is created String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

409

Entitlement already exist ErrorObjectAlreadyAvailable
Up 
post /scim/v2/Entitlements/.search
(entitlementsSearchPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

SearchRequest SearchRequest (required)
Body Parameter —

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid entitlements are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

Groups

Up 
get /scim/v2/Groups
(groupsGet)

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null
filter (optional)
Query Parameter — Filter expression default: null
startIndex (optional)
Query Parameter — Pagination start index default: null format: int32
count (optional)
Query Parameter — Pagination page size default: null format: int32
domain (optional)
Query Parameter — The name of the user store where filtering needs to be applied. default: null

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid groups are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
delete /scim/v2/Groups/{id}
(groupsIdDelete)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

204

Group is deleted

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
get /scim/v2/Groups/{id}
(groupsIdGet)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid group is found String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
patch /scim/v2/Groups/{id}
(groupsIdPatch)

Path parameters

id (required)
Path Parameter — Unique id of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

PatchRequest PatchRequest (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Group is updated String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
put /scim/v2/Groups/{id}
(groupsIdPut)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Group is updated String

400

Invalid Input ErrorInvalidInput

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
post /scim/v2/Groups
(groupsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

201

Valid group is created String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

409

Group already exist ErrorObjectAlreadyAvailable
Up 
post /scim/v2/Groups/.search
(groupsSearchPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

SearchRequest SearchRequest (required)
Body Parameter —

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid groups are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

JwksRest

Up 
get /default/jwks
(getJwks)

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK String

ListRest

Up 
post /list/data
(getList)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ListRequest ListRequest (required)
Body Parameter —

Return type

ListResult

Example data

Content-Type: application/json 
{
  "total" : 0,
  "data" : [ "{}", "{}" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ListResult
Up 
get /list/definition/{listName}
(getListDefinition)

Path parameters

listName (required)
Path Parameter — default: null

Return type

ListDefinition

Example data

Content-Type: application/json 
{
  "name" : "name",
  "filterDependency" : [ [ "filterDependency", "filterDependency" ], [ "filterDependency", "filterDependency" ] ],
  "requiredFilterSets" : [ [ "requiredFilterSets", "requiredFilterSets" ], [ "requiredFilterSets", "requiredFilterSets" ] ],
  "attributes" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "filters" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "mutualExclusiveFilters" : [ [ "mutualExclusiveFilters", "mutualExclusiveFilters" ], [ "mutualExclusiveFilters", "mutualExclusiveFilters" ] ],
  "sortBys" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "properties" : {
    "key" : "properties"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ListDefinition
Up 
get /list/definition
(getListDefinitions)

Return type

array[ListDefinition]

Example data

Content-Type: application/json 
[ {
  "name" : "name",
  "filterDependency" : [ [ "filterDependency", "filterDependency" ], [ "filterDependency", "filterDependency" ] ],
  "requiredFilterSets" : [ [ "requiredFilterSets", "requiredFilterSets" ], [ "requiredFilterSets", "requiredFilterSets" ] ],
  "attributes" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "filters" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "mutualExclusiveFilters" : [ [ "mutualExclusiveFilters", "mutualExclusiveFilters" ], [ "mutualExclusiveFilters", "mutualExclusiveFilters" ] ],
  "sortBys" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "properties" : {
    "key" : "properties"
  }
}, {
  "name" : "name",
  "filterDependency" : [ [ "filterDependency", "filterDependency" ], [ "filterDependency", "filterDependency" ] ],
  "requiredFilterSets" : [ [ "requiredFilterSets", "requiredFilterSets" ], [ "requiredFilterSets", "requiredFilterSets" ] ],
  "attributes" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "filters" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "mutualExclusiveFilters" : [ [ "mutualExclusiveFilters", "mutualExclusiveFilters" ], [ "mutualExclusiveFilters", "mutualExclusiveFilters" ] ],
  "sortBys" : [ {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  }, {
    "name" : "name",
    "properties" : {
      "key" : "properties"
    }
  } ],
  "properties" : {
    "key" : "properties"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK
Up 
get /list/jsonSchema/{listNames}
(getListJsonSchema)

Path parameters

listNames (required)
Path Parameter — default: null

Return type

map[ListJsonSchema]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

Me

Up 
delete /scim/v2/Me
(meDelete)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

204

User is deleted

401

Unauthorized ErrorUnauthorized

501

Self delete is not suported ErrorNotimplemented
Up 
get /scim/v2/Me
(meGet)

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

User is found and returned String

401

Unauthorized access ErrorUnauthorized
Up 
patch /scim/v2/Me
(mePatch)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

PatchRequest PatchRequest (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

User is updated String

401

Unauthorized ErrorUnauthorized
Up 
post /scim/v2/Me
(mePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

201

User is created. String

400

Invalid Input ErrorInvalidInput

401

Unauthorized ErrorUnauthorized

500

Internal Server Error ErrorInternalServerError
Up 
put /scim/v2/Me
(mePut)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

User is updated String

401

Unauthorized access ErrorUnauthorized

OrgAndRegistrationRest

Up 
delete /org/{id}
(delete)

Path parameters

id (required)
Path Parameter — default: null

Responses

200

OK
Up 
get /org/{id}
(getById)

Path parameters

id (required)
Path Parameter — default: null

Return type

Org

Example data

Content-Type: application/json 
{
  "subDomain" : "subDomain",
  "name" : "name",
  "id" : "id",
  "updatedOn" : 0,
  "type" : "type",
  "primaryContactEmail" : "primaryContactEmail",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK Org
Up 
post /registration
(register)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Registration Registration (required)
Body Parameter —

Responses

200

OK
Up 
put /org/{id}
(update)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Org Org (required)
Body Parameter —

Return type

Org

Example data

Content-Type: application/json 
{
  "subDomain" : "subDomain",
  "name" : "name",
  "id" : "id",
  "updatedOn" : 0,
  "type" : "type",
  "primaryContactEmail" : "primaryContactEmail",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK Org

ResourceTypes

Up 
get /scim/v2/ResourceTypes
(resourceTypesGet)

Return type

ResourceTypeResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Schema is found ResourceTypeResponse

401

Unauthorized ErrorUnauthorized

Roles

Up 
get /scim/v2/Roles
(rolesGet)

Query parameters

filter (optional)
Query Parameter — Filter expression default: null
attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null
startIndex (optional)
Query Parameter — Pagination start index default: null format: int32
count (optional)
Query Parameter — Pagination page size default: null format: int32

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid roles are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
delete /scim/v2/Roles/{id}
(rolesIdDelete)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

204

Role is deleted

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
get /scim/v2/Roles/{id}
(rolesIdGet)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid role is found String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
patch /scim/v2/Roles/{id}
(rolesIdPatch)

Path parameters

id (required)
Path Parameter — Unique id of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

PatchRequest PatchRequest (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Role is updated String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

406

Not Acceptable ErrorNotAcceptable
Up 
put /scim/v2/Roles/{id}
(rolesIdPut)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Role is updated String

400

Invalid Input ErrorInvalidInput

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

406

Not Acceptable ErrorNotAcceptable
Up 
post /scim/v2/Roles
(rolesPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

201

Valid role is created String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

409

Role already exist ErrorObjectAlreadyAvailable
Up 
post /scim/v2/Roles/.search
(rolesSearchPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

SearchRequest SearchRequest (required)
Body Parameter —

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid roles are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

SchemaRest

Up 
post /schema/applicationroleschema
(createApplicationRoleschema)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ApplicationRoleSchema ApplicationRoleSchema (required)
Body Parameter —

Return type

ApplicationRoleSchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "description" : "description",
  "id" : "id",
  "updatedOn" : 0,
  "applicationId" : "applicationId",
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ApplicationRoleSchema
Up 
delete /schema/applicationroleschema/{id}
(deleteApplicationRoleSchema)

Path parameters

id (required)
Path Parameter — default: null

Responses

200

OK
Up 
get /schema/application/{applicationId}/roleschema
(getApplicationRoleSchemaByApp)

Path parameters

applicationId (required)
Path Parameter — default: null

Return type

ApplicationRoleSchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "description" : "description",
  "id" : "id",
  "updatedOn" : 0,
  "applicationId" : "applicationId",
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ApplicationRoleSchema
Up 
get /schema/listandentity/{name}
(getEntityAndListMetaSchema)

Path parameters

name (required)
Path Parameter — default: null

Return type

EntityAndListMetaSchema

Example data

Content-Type: application/json 
{
  "listMetaUiSchema" : "listMetaUiSchema",
  "name" : "name",
  "entityUiSchema" : "entityUiSchema",
  "listMetaJsonSchema" : "listMetaJsonSchema",
  "listColumns" : [ "listColumns", "listColumns" ],
  "entityJsonSchema" : "entityJsonSchema"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK EntityAndListMetaSchema
Up 
get /schema/entity/{id}
(getEntitySchema)

Path parameters

id (required)
Path Parameter — default: null

Return type

EntitySchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "id" : "id",
  "updatedOn" : 0,
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK EntitySchema
Up 
get /schema/rolemembershipschema/{id}
(getRoleMembershipSchema)

Path parameters

id (required)
Path Parameter — default: null

Return type

Schema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "uiSchema" : "uiSchema"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK Schema
Up 
get /schema/applicationroleschema/{id}
(getpplicationRoleSchema)

Path parameters

id (required)
Path Parameter — default: null

Return type

ApplicationRoleSchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "description" : "description",
  "id" : "id",
  "updatedOn" : 0,
  "applicationId" : "applicationId",
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ApplicationRoleSchema
Up 
post /schema/applicationroleschema/{id}
(restoreApplicationRoleschema)

Path parameters

id (required)
Path Parameter — default: null

Return type

ApplicationRoleSchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "description" : "description",
  "id" : "id",
  "updatedOn" : 0,
  "applicationId" : "applicationId",
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ApplicationRoleSchema
Up 
post /schema/entity/{id}
(restoreToDefault)

Path parameters

id (required)
Path Parameter — default: null

Return type

EntitySchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "id" : "id",
  "updatedOn" : 0,
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK EntitySchema
Up 
put /schema/applicationroleschema/{id}
(updateApplicationRoleSchema)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ApplicationRoleSchema ApplicationRoleSchema (required)
Body Parameter —

Return type

ApplicationRoleSchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "description" : "description",
  "id" : "id",
  "updatedOn" : 0,
  "applicationId" : "applicationId",
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK ApplicationRoleSchema
Up 
put /schema/entity/{id}
(updateEntitySchema)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

EntitySchema EntitySchema (required)
Body Parameter —

Return type

EntitySchema

Example data

Content-Type: application/json 
{
  "jsonSchema" : "jsonSchema",
  "name" : "name",
  "uiSchema" : "uiSchema",
  "id" : "id",
  "updatedOn" : 0,
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK EntitySchema

Schemas

Up 
get /scim/v2/Schemas
(schemasGet)

Return type

Schemas

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Schema is found Schemas

401

Unauthorized ErrorUnauthorized

ServiceProviderConfig

Up 
get /scim/v2/ServiceProviderConfig
(serviceProviderConfigGet)

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Schema is found Object

401

Unauthorized ErrorUnauthorized

SoDRest

Up 
post /sod/StaticSoDs
(createStaticSoD)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

StaticSoD StaticSoD (required)
Body Parameter —

Return type

StaticSoD

Example data

Content-Type: */*
{
  "mutualExclusiveRoles" : [ {
    "name" : "name",
    "id" : "id"
  }, {
    "name" : "name",
    "id" : "id"
  } ],
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "updatedOn" : 0,
  "orgId" : "orgId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK StaticSoD
Up 
delete /sod/StaticSoDs/{id}
(deleteStaticSoD)

Path parameters

id (required)
Path Parameter — default: null

Responses

200

OK
Up 
get /sod/StaticSoDs/{id}
(getStaticSoD)

Path parameters

id (required)
Path Parameter — default: null

Return type

AuthorizedEntityStaticSoD

Example data

Content-Type: application/json 
{
  "authorizedActions" : [ "authorizedActions", "authorizedActions" ],
  "entity" : {
    "mutualExclusiveRoles" : [ {
      "name" : "name",
      "id" : "id"
    }, {
      "name" : "name",
      "id" : "id"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "id",
    "updatedOn" : 0,
    "orgId" : "orgId"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK AuthorizedEntityStaticSoD
Up 
put /sod/StaticSoDs/{id}
(updateStaticSoD)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

StaticSoD StaticSoD (required)
Body Parameter —

Responses

200

OK

Users

Up 
get /scim/v2/Users
(usersGet)

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null
filter (optional)
Query Parameter — Filter expression default: null
startIndex (optional)
Query Parameter — Pagination start index default: null format: int32
count (optional)
Query Parameter — Pagination page size default: null format: int32
domain (optional)
Query Parameter — The name of the user store where filtering needs to be applied. default: null

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid users are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
delete /scim/v2/Users/{id}
(usersIdDelete)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

204

User is deleted

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
get /scim/v2/Users/{id}
(usersIdGet)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid user is found String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
patch /scim/v2/Users/{id}
(usersIdPatch)

Path parameters

id (required)
Path Parameter — Unique id of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

PatchRequest PatchRequest (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid user is found String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
put /scim/v2/Users/{id}
(usersIdPut)

Path parameters

id (required)
Path Parameter — Unique ID of the resource type. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid user is found String

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden
Up 
post /scim/v2/Users
(usersPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

request_body object (required)
Body Parameter —

Query parameters

attributes (optional)
Query Parameter — Attributes SHALL be returned default: null
excludedAttributes (optional)
Query Parameter — Attributes SHALL NOT be returned default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

201

User is created. String

400

Invalid Input ErrorInvalidInput

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

409

User already exist ErrorObjectAlreadyAvailable

500

Internal Server Error ErrorInternalServerError
Up 
post /scim/v2/Users/.search
(usersSearchPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/scim+json

Request body

SearchRequest SearchRequest (required)
Body Parameter —

Return type

ListResponse

Example data

Content-Type: application/scim+json 
Custom MIME type example not yet supported: application/scim+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/scim+json

Responses

200

Valid users are found ListResponse

401

Unauthorized ErrorUnauthorized

403

Forbidden ErrorForbidden

Models

[ Jump to Methods ]

Table of Contents

  1. ApiKey -
  2. Application -
  3. ApplicationPolicy -
  4. ApplicationRoleSchema -
  5. Attribute -
  6. AuthorizedEntityApiKey -
  7. AuthorizedEntityApplication -
  8. AuthorizedEntityStaticSoD -
  9. AuthorizedEntityVersionAndPolicy -
  10. AuthorizedEntityVersionInfo -
  11. BulkItem -
  12. BulkOperation -
  13. BulkOperationStatus -
  14. BulkRequest -
  15. BulkResponse -
  16. CheckAccessResponse -
  17. EntitlementRequest -
  18. EntityAndListMetaSchema -
  19. EntitySchema -
  20. ErrorForbidden -
  21. ErrorInternalServerError -
  22. ErrorInvalidInput -
  23. ErrorNotAcceptable -
  24. ErrorNotimplemented -
  25. ErrorObjectAlreadyAvailable -
  26. ErrorUnauthorized -
  27. FilterResponse -
  28. IdAndName -
  29. JsonSchema -
  30. ListDefinition -
  31. ListJsonSchema -
  32. ListRequest -
  33. ListResponse -
  34. ListResult -
  35. MembershipWithSchema -
  36. NameAndProperties -
  37. Org -
  38. PatchItem -
  39. PatchRequest -
  40. QueryActionResponse -
  41. QueryFunctionalAccessResponse -
  42. QueryFunctionalRequest -
  43. QueryRequest -
  44. QueryUserResponse -
  45. RawPolicyRecord -
  46. Registration -
  47. ResourceAction -
  48. ResourceType -
  49. ResourceTypeMeta -
  50. ResourceTypeResponse -
  51. ResourceTypeSchemaExtension -
  52. Schema -
  53. Schema2 -
  54. Schemas -
  55. SearchRequest -
  56. StaticSoD -
  57. VersionAndPolicy -
  58. VersionInfo -

ApiKey - Up

id (optional)
String
orgId (optional)
String
expTime (optional)
Long format: int64
owner (optional)
String
name (optional)
String

Application - Up

id (optional)
String
orgId (optional)
String
name (optional)
String
description (optional)
String
updatedOn (optional)
Long format: int64

ApplicationPolicy - Up

id (optional)
String
orgId (optional)
String
policyRecords (optional)
array[RawPolicyRecord]

ApplicationRoleSchema - Up

id (optional)
String
orgId (optional)
String
name (optional)
String
jsonSchema (optional)
String
uiSchema (optional)
String
updatedOn (optional)
Long format: int64
applicationId (optional)
String
description (optional)
String

Attribute - Up

name (optional)
String
type (optional)
String
Enum:
string
boolean
decimal
integer
dateTime
reference
complex
binary
subAttributes (optional)
array[Attribute]
description (optional)
String
multiValued (optional)
Boolean
required (optional)
Boolean
canonicalValues (optional)
array[String]
caseExact (optional)
Boolean
mutability (optional)
String
Enum:
readOnly
readWrite
immutable
writeOnly
returned (optional)
String
Enum:
always
never
default
request
uniqueness (optional)
String
Enum:
none
server
global
referenceTypes (optional)
array[String]

AuthorizedEntityApiKey - Up

authorizedActions (optional)
set[String]
entity (optional)
ApiKey

AuthorizedEntityApplication - Up

authorizedActions (optional)
set[String]
entity (optional)
Application

AuthorizedEntityStaticSoD - Up

authorizedActions (optional)
set[String]
entity (optional)
StaticSoD

AuthorizedEntityVersionAndPolicy - Up

authorizedActions (optional)
set[String]
entity (optional)
VersionAndPolicy

AuthorizedEntityVersionInfo - Up

authorizedActions (optional)
set[String]
entity (optional)
VersionInfo

BulkItem - Up

method (optional)
String
path (optional)
String
bulkId (optional)
String
data (optional)
map[String, Object]

BulkOperation - Up

bulkId (optional)
String
method (optional)
String
location (optional)
String
status (optional)
BulkOperationStatus

BulkOperationStatus - Up

code (optional)
String

BulkRequest - Up

failOnErrors (optional)
Integer format: int32
schemas (optional)
array[String]
Operations (optional)
array[BulkItem]

BulkResponse - Up

schemas (optional)
array[String]
Operations (optional)
BulkOperation

CheckAccessResponse - Up

granted (optional)
Boolean
obligations (optional)
map[String, array[Object]]

EntitlementRequest - Up

user (optional)
String
app (optional)
String
resource (optional)
String
context (optional)
map[String, Object]
action (optional)
String

EntityAndListMetaSchema - Up

name (optional)
String
entityJsonSchema (optional)
String
entityUiSchema (optional)
String
listMetaJsonSchema (optional)
String
listMetaUiSchema (optional)
String
listColumns (optional)
array[String]

EntitySchema - Up

id (optional)
String
orgId (optional)
String
name (optional)
String
jsonSchema (optional)
String
uiSchema (optional)
String
updatedOn (optional)
Long format: int64

ErrorForbidden - Up

status
String
schemas (optional)
String
scimType (optional)
String

ErrorInternalServerError - Up

status
String
schemas (optional)
String
detail
String

ErrorInvalidInput - Up

status
String
schemas (optional)
String
scimType (optional)
String
detail
String

ErrorNotAcceptable - Up

status
String
schemas (optional)
String
scimType (optional)
String

ErrorNotimplemented - Up

status
String
schemas (optional)
String
detail
String

ErrorObjectAlreadyAvailable - Up

status
String
schemas (optional)
String
detail
String

ErrorUnauthorized - Up

status
String
schemas (optional)
String
scimType (optional)
String

FilterResponse - Up

granted (optional)
Boolean
filterObject (optional)
Object

IdAndName - Up

name (optional)
String
id (optional)
String

JsonSchema - Up

title (optional)
String
type (optional)
String
properties (optional)
map[String, Object]

ListDefinition - Up

name (optional)
String
attributes (optional)
array[NameAndProperties]
sortBys (optional)
array[NameAndProperties]
filters (optional)
array[NameAndProperties]
mutualExclusiveFilters (optional)
array[set[String]]
requiredFilterSets (optional)
array[set[String]]
filterDependency (optional)
array[array[String]]
properties (optional)
map[String, String]

ListJsonSchema - Up

jsonSchema (optional)
JsonSchema
uiSchema (optional)
map[String, Object]
columnNames (optional)
array[String]

ListRequest - Up

listName (optional)
String
attributes (optional)
array[String]
sortBy (optional)
String
filters (optional)
map[String, Object]
includeTotal (optional)
Boolean
environment (optional)
map[String, Object]

ListResponse - Up

totalResults (optional)
Integer format: int32
startIndex (optional)
Integer format: int32
itemsPerPage (optional)
Integer format: int32
schemas (optional)
array[String]
Resources (optional)
array[map[String, Object]]

ListResult - Up

total (optional)
Integer format: int32
data (optional)
array[Object]

MembershipWithSchema - Up

membership (optional)
map[String, Object]
schema (optional)
Schema

NameAndProperties - Up

name (optional)
String
properties (optional)
map[String, String]

Org - Up

id (optional)
String
name (optional)
String
subDomain (optional)
String
status (optional)
String
type (optional)
String
primaryContactEmail (optional)
String
updatedOn (optional)
Long format: int64

PatchItem - Up

op (optional)
String
Enum:
add
remove
replace
path (optional)
String
value (optional)
array[Object]

PatchRequest - Up

schemas (optional)
array[Object]
Operations (optional)
array[PatchItem]

QueryActionResponse - Up

actions (optional)
set[String]

QueryFunctionalAccessResponse - Up

functionalAccess (optional)
set[ResourceAction]

QueryFunctionalRequest - Up

resource (optional)
String
action (optional)
String
context (optional)
map[String, Object]

QueryRequest - Up

user (optional)
String
app (optional)
String
resource (optional)
String
context (optional)
map[String, Object]

QueryUserResponse - Up

users (optional)
array[String]

RawPolicyRecord - Up

denyPolicy (optional)
Boolean
resources (optional)
String
actions (optional)
String
subjects (optional)
String
condition (optional)
String
obligations (optional)
String
functionalCondition (optional)
String
note (optional)
String

Registration - Up

email (optional)
String
orgName (optional)
String
password (optional)
String
firstName (optional)
String
lastName (optional)
String
captcha (optional)
String

ResourceAction - Up

resource (optional)
String
action (optional)
String

ResourceType - Up

schemas (optional)
array[String]
schema (optional)
String
endpoint (optional)
String
meta (optional)
ResourceTypeMeta
name (optional)
String
description (optional)
String
schemaExtensions (optional)
array[ResourceTypeSchemaExtension]
id (optional)
String

ResourceTypeMeta - Up

location (optional)
String
resourceType (optional)
String

ResourceTypeResponse - Up

schemas (optional)
array[String]
Resources (optional)
array[ResourceType]
startIndex (optional)
Integer format: int32
totalResults (optional)
Integer format: int32
itemsPerPage (optional)
Integer format: int32

ResourceTypeSchemaExtension - Up

schema (optional)
String
required (optional)
Boolean

Schema - Up

jsonSchema (optional)
String
uiSchema (optional)
String

Schema2 - Up

schemas (optional)
array[String]
attributes (optional)
array[Attribute]
name (optional)
String
description (optional)
String
id (optional)
String

Schemas - Up

schemas (optional)
array[String]
Resources (optional)
array[Schema2]
startIndex (optional)
Integer format: int32
totalResults (optional)
Integer format: int32
itemsPerPage (optional)
Integer format: int32

SearchRequest - Up

schemas (optional)
Object
startIndex (optional)
Integer format: int32
count (optional)
Integer format: int32
filter (optional)
String

StaticSoD - Up

id (optional)
String
orgId (optional)
String
name (optional)
String
description (optional)
String
updatedOn (optional)
Long format: int64
mutualExclusiveRoles (optional)
array[IdAndName]

VersionAndPolicy - Up

applicationPolicy (optional)
ApplicationPolicy
versionInfo (optional)
VersionInfo

VersionInfo - Up

id (optional)
String
orgId (optional)
String
applicationId (optional)
String
label (optional)
String
version (optional)
Integer format: int32
desc (optional)
String
status (optional)
String
approvedBy (optional)
String
approvedOn (optional)
Date format: date-time
deployedBy (optional)
String
deployedOn (optional)
Date format: date-time
lastUpdatedBy (optional)
String
lastUpdatedOn (optional)
Date format: date-time
undeployedBy (optional)
String
undeployedOn (optional)
Date format: date-time
updatedOn (optional)
Long format: int64
policyId (optional)
String
note (optional)
String