{ "swagger":"2.0", "info":{ "title":"SCIM REST API for Oracle Unified Directory", "description":"SCIM API for Oracle Unified Directory", "version":"2019.09.23", "x-summary":"SCIM API for Oracle Unified Directory" }, "consumes":[ "application/scim+json" ], "produces":[ "application/scim+json" ], "tags":[ { "name":"Groups", "description":"The operations from the Groups category." }, { "name":"Logged User", "description":"The operations from the Logged User category." }, { "name":"ResourceTypes", "description":"The operations from the ResourceTypes category." }, { "name":"Schemas", "description":"The operations from the Schemas category." }, { "name":"Users", "description":"The operations from the Users category." } ], "paths":{ "/iam/directory/oud/scim/v1/ResourceTypes":{ "get":{ "tags":[ "ResourceTypes" ], "summary":"Find all the Resources", "description":"Returns the details of Resources created and supported", "produces":[ "application/scim+json" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/ResourceTypesSuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-ResourceTypes-get", "x-filename-id":"iam-directory-oud-scim-v1-resourcetypes-get" } }, "/iam/directory/oud/scim/v1/Schemas":{ "get":{ "tags":[ "Schemas" ], "summary":"Find all the Schemas", "description":"Returns the details of schemas created and supported", "produces":[ "application/scim+json" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SchemaSuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Schemas-get", "x-filename-id":"iam-directory-oud-scim-v1-schemas-get" } }, "/iam/directory/oud/scim/v1/Users":{ "post":{ "summary":"Create a User", "description":"Used to create a User in the directory. The response includes the display name and other details about the user.", "tags":[ "Users" ], "consumes":[ "application/scim+json" ], "produces":[ "application/scim+json" ], "parameters":[ { "name":"POSTRequest", "in":"body", "description":"User that needs to be created", "required":true, "schema":{ "$ref":"#/definitions/POSTANDPUTRequest" } } ], "responses":{ "201":{ "description":"Created", "schema":{ "$ref":"#/definitions/GroupSuccessResponse" } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Users-post", "x-filename-id":"iam-directory-oud-scim-v1-users-post" }, "get":{ "tags":[ "Users" ], "summary":"Find all Users", "description":"Returns the details of all the users", "produces":[ "application/scim+json" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Users-get", "x-filename-id":"iam-directory-oud-scim-v1-users-get" } }, "/iam/directory/oud/scim/v1/Schemas/{schemaID}":{ "get":{ "tags":[ "Schemas" ], "summary":"Find a specific Schema", "description":"Returns the details of schema querried", "produces":[ "application/scim+json" ], "parameters":[ { "name":"schemaID", "in":"path", "description":"schema id for the Schema to be fetched.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SchemaSearchResultEntry" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Schemas-{schemaID}-get", "x-filename-id":"iam-directory-oud-scim-v1-schemas-schemaid-get" } }, "/iam/directory/oud/scim/v1/Users/{entryUUID}":{ "get":{ "tags":[ "Users" ], "summary":"Find a specific user", "description":"Returns the details of specific user the user based on the entryUUID", "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"entryUUID for the LDAP entry to be fetched.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Users-{entryUUID}-get", "x-filename-id":"iam-directory-oud-scim-v1-users-entryuuid-get" }, "patch":{ "tags":[ "Users" ], "summary":"Modify a user", "description":"by giving the EntryUUID", "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"LDAP DN of the entry to be modified", "required":true, "type":"string" }, { "name":"PatchRequest", "in":"body", "description":"Entry that needs to be modified", "required":true, "schema":{ "$ref":"#/definitions/PatchRequest" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "400":{ "description":"ERROR" }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Users-{entryUUID}-patch", "x-filename-id":"iam-directory-oud-scim-v1-users-entryuuid-patch" }, "delete":{ "tags":[ "Users" ], "summary":"Delete a user", "description":"Deletes a User", "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"dn of the entry to be deleted", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"No content" }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Users-{entryUUID}-delete", "x-filename-id":"iam-directory-oud-scim-v1-users-entryuuid-delete" }, "put":{ "tags":[ "Users" ], "summary":"Replace a User", "description":"Used to replace a User in the directory. The body contains the user with the details it needs to be replaced with and the response has the details after it has been modified.", "consumes":[ "application/scim+json" ], "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"entryUUID for the LDAP entry to be fetched.", "required":true, "type":"string" }, { "name":"PUTRequest", "in":"body", "description":"User that needs to be created", "required":true, "schema":{ "$ref":"#/definitions/POSTANDPUTRequest" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Users-{entryUUID}-put", "x-filename-id":"iam-directory-oud-scim-v1-users-entryuuid-put" } }, "/iam/directory/oud/scim/v1/Me":{ "get":{ "tags":[ "Logged User" ], "summary":"Find the logged in Users", "description":"Find the logged in User", "produces":[ "application/scim+json" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Me-get", "x-filename-id":"iam-directory-oud-scim-v1-me-get" }, "patch":{ "tags":[ "Logged User" ], "summary":"Modify the logged in user", "description":"Modify the logged in User", "produces":[ "application/scim+json" ], "parameters":[ { "name":"PatchRequest", "in":"body", "description":"Entry that needs to be modified", "required":true, "schema":{ "$ref":"#/definitions/PatchRequest" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "400":{ "description":"ERROR" }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Me-patch", "x-filename-id":"iam-directory-oud-scim-v1-me-patch" }, "delete":{ "tags":[ "Logged User" ], "summary":"Delete the logged in user", "description":"Deletes the logged in User", "produces":[ "application/scim+json" ], "responses":{ "204":{ "description":"No content" }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Me-delete", "x-filename-id":"iam-directory-oud-scim-v1-me-delete" }, "put":{ "tags":[ "Logged User" ], "summary":"Replace the User", "description":"Repalces the logged in User. The body contains the user with the details it needs to be replaced with and the response has the details after it has been modified.", "consumes":[ "application/scim+json" ], "produces":[ "application/scim+json" ], "parameters":[ { "name":"PUTRequest", "in":"body", "description":"User that needs to be created", "required":true, "schema":{ "$ref":"#/definitions/POSTANDPUTRequest" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Me-put", "x-filename-id":"iam-directory-oud-scim-v1-me-put" } }, "/iam/directory/oud/scim/v1/Groups":{ "post":{ "summary":"Create a Group", "description":"Used to create a Group in the directory. The response includes the details about the Group.", "tags":[ "Groups" ], "consumes":[ "application/scim+json" ], "produces":[ "application/scim+json" ], "parameters":[ { "name":"POSTRequest", "in":"body", "description":"User that needs to be created", "required":true, "schema":{ "$ref":"#/definitions/POSTANDPUTRequestForGROUP" } } ], "responses":{ "201":{ "description":"Created", "schema":{ "$ref":"#/definitions/GroupSuccessResponse" } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Groups-post", "x-filename-id":"iam-directory-oud-scim-v1-groups-post" }, "get":{ "tags":[ "Groups" ], "summary":"Find all the Groups in the directory", "description":"Returns the Groups present in the directory", "produces":[ "application/scim+json" ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/GroupSuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Groups-get", "x-filename-id":"iam-directory-oud-scim-v1-groups-get" } }, "/iam/directory/oud/scim/v1/Groups/{entryUUID}":{ "get":{ "tags":[ "Groups" ], "summary":"Find a specific Group", "description":"Returns the details of all the Group based on the entryUUID provided", "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"entryUUID for the Group to be fetched.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/SuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Groups-{entryUUID}-get", "x-filename-id":"iam-directory-oud-scim-v1-groups-entryuuid-get" }, "patch":{ "tags":[ "Groups" ], "summary":"Modify a group", "description":"by giving the EntryUUID", "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"LDAP DN of the entry to be modified", "required":true, "type":"string" }, { "name":"PatchRequest", "in":"body", "description":"Entry that needs to be modified", "required":true, "schema":{ "$ref":"#/definitions/PatchRequest" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/GroupSuccessResponse" } }, "400":{ "description":"ERROR" }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Groups-{entryUUID}-patch", "x-filename-id":"iam-directory-oud-scim-v1-groups-entryuuid-patch" }, "delete":{ "tags":[ "Groups" ], "summary":"Delete a Group", "description":"Deletes a Group", "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"dn of the entry to be deleted", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"No content" }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Groups-{entryUUID}-delete", "x-filename-id":"iam-directory-oud-scim-v1-groups-entryuuid-delete" }, "put":{ "summary":"Replace a group", "description":"Used to replace a Group in the directory. The body contains the group with the details it needs to be replaced with and the response has the details after it has been modified.", "tags":[ "Groups" ], "consumes":[ "application/scim+json" ], "produces":[ "application/scim+json" ], "parameters":[ { "name":"entryUUID", "in":"path", "description":"entryUUID for the LDAP entry to be fetched.", "required":true, "type":"string" }, { "name":"PUTRequest", "in":"body", "description":"User that needs to be created", "required":true, "schema":{ "$ref":"#/definitions/POSTANDPUTRequestForGROUP" } } ], "responses":{ "200":{ "description":"OK", "schema":{ "$ref":"#/definitions/GroupSuccessResponse" } }, "406":{ "description":"Not Acceptable", "schema":{ "$ref":"#/definitions/ErrorResponse" } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/ErrorResponse" } } }, "x-internal-id":"iam-directory-oud-scim-v1-Groups-{entryUUID}-put", "x-filename-id":"iam-directory-oud-scim-v1-groups-entryuuid-put" } } }, "definitions":{ "Core Group Properties":{ "type":"object", "required":[ "members", "displayName" ], "properties":{ "members":{ "type":"array", "description":"Members belonging to the Group.", "items":{ "type":"string" } }, "displayName":{ "type":"string", "description":"Display name for the group." } } }, "Oracle specific Group Properties":{ "type":"object", "properties":{ "objectClass":{ "type":"array", "description":"Objectclass(es) required for the Group.", "items":{ "type":"string" } }, "description":{ "type":"array", "description":"Description of the Group.", "items":{ "type":"string" } }, "owner":{ "type":"array", "description":"Owner of the group.", "items":{ "type":"string" } }, "ou":{ "type":"array", "description":"Organizational Unit the Group is a part of.", "items":{ "type":"string" } }, "businessCategory":{ "type":"array", "description":"Buisness Category of the Group.", "items":{ "type":"string" } }, "o":{ "type":"array", "description":"Organiation the group is a part of.", "items":{ "type":"string" } } } }, "Core User Properties":{ "type":"object", "required":[ "userName", "name" ], "properties":{ "userName":{ "type":"array", "description":"CN (common name) of the entry", "items":{ "type":"string" } }, "name":{ "type":"array", "description":"SCIM SubAttributes:
Name of the particular User.", "items":{ "$ref":"#/definitions/nameSubAttributes" } }, "displayName":{ "type":"array", "description":"Display name of the User.", "items":{ "type":"string" } }, "phoneNumbers":{ "type":"array", "description":"phoneNumbers of the specific User", "items":{ "type":"string" } }, "x509Certificates":{ "type":"array", "description":"The certificates for the particular User.", "items":{ "type":"object" } }, "photos":{ "type":"array", "description":"jpeg for the particular User.", "items":{ "type":"string" } }, "title":{ "type":"array", "description":"title of that specific User.", "items":{ "type":"string" } }, "userType":{ "type":"array", "description":"Type of that specific User.", "items":{ "type":"string" } }, "preferredLanguage":{ "type":"array", "description":"Preffered Language of that specific User.", "items":{ "type":"string" } }, "password":{ "type":"array", "description":"password of that specific User.", "items":{ "type":"string" } }, "emails":{ "type":"array", "description":"email of that specific User.", "items":{ "type":"string" } }, "addresses":{ "type":"array", "description":"SCIM SubAttributes:
Addresses of the particular User.", "items":{ "$ref":"#/definitions/addressSubAttributes" } } } }, "Oracle specific User Properties":{ "type":"object", "properties":{ "objectClass":{ "type":"array", "description":"Objectclass(es) which this entry belongs to.", "items":{ "type":"string" } }, "mobile":{ "type":"array", "description":"Mobile of the User.", "items":{ "type":"string" } }, "roomNumber":{ "type":"array", "description":"Room Number of the User.", "items":{ "type":"string" } }, "teletexTerminalIdentifier":{ "type":"array", "description":"teletexTerminalIdentifier value of the User.", "items":{ "type":"string" } }, "description":{ "type":"array", "description":"Description of the User.", "items":{ "type":"string" } }, "carLicense":{ "type":"array", "description":"carLicense of the User.", "items":{ "type":"string" } }, "telexNumber":{ "type":"array", "description":"telexNumber of the User.", "items":{ "type":"string" } }, "postOfficeBox":{ "type":"array", "description":"postOfficeBox of the User.", "items":{ "type":"string" } }, "secretary":{ "type":"array", "description":"secretary of the User.", "items":{ "type":"string" } }, "userSMIMECertificate":{ "type":"array", "description":"PKCS#7 SignedData used to support S/MIME.", "items":{ "type":"string" } }, "pager":{ "type":"array", "description":"pager of the User.", "items":{ "type":"string" } }, "x500UniqueIdentifier":{ "type":"array", "description":"x500UniqueIdentifier of the User.", "items":{ "type":"string" } }, "labeledURI":{ "type":"array", "description":"Uniform Resource Identifier with optional label.", "items":{ "type":"string" } }, "preferredDeliveryMethod":{ "type":"string", "description":"Delivery method preferred by the User." }, "userPKCS12":{ "type":"array", "description":"PKCS #12 PFX PDU for exchange of personal identity information.", "items":{ "type":"string" } }, "businessCategory":{ "type":"array", "description":"Business Category of the User.", "items":{ "type":"string" } }, "internationaliSDNNumber":{ "type":"array", "description":"internationaliSDNNumber of the User.", "items":{ "type":"string" } }, "destinationIndicator":{ "type":"array", "description":"Destination Indicator of the User.", "items":{ "type":"string" } }, "facsimileTelephoneNumber":{ "type":"array", "description":"facsimileTelephoneNumber of the User.", "items":{ "type":"string" } }, "homePhone":{ "type":"array", "description":"Home Phone number of the User.", "items":{ "type":"string" } }, "initials":{ "type":"array", "description":"initials of the User.", "items":{ "type":"string" } }, "physicalDeliveryOfficeName":{ "type":"array", "description":"Physical Delivery Office Name of the User.", "items":{ "type":"string" } } } }, "Enterprise specific User Properties":{ "type":"object", "properties":{ "manager":{ "type":"array", "description":"SCIM SubAttributes:
Manager of the particular User.", "items":{ "$ref":"#/definitions/managerSubAttributes" } }, "department":{ "type":"array", "description":"Department the User is part of.", "items":{ "type":"string" } }, "organization":{ "type":"array", "description":"Organization the User is part of.", "items":{ "type":"string" } }, "employeeNumber":{ "type":"array", "description":"employeeNumber of the User.", "items":{ "type":"string" } } } }, "nameSubAttributes":{ "type":"object", "properties":{ "formatted":{ "type":"string" }, "familyName":{ "type":"string" }, "givenName":{ "type":"string" } } }, "addressSubAttributes":{ "type":"object", "properties":{ "formatted":{ "type":"string" }, "streetAddress":{ "type":"string" }, "region":{ "type":"string" }, "locality":{ "type":"string" }, "country":{ "type":"string" }, "postalCode":{ "type":"string" } } }, "managerSubAttributes":{ "type":"object", "properties":{ "managerId":{ "type":"string" }, "displayName":{ "type":"string" } } }, "POSTANDPUTRequestForGROUP":{ "type":"object", "required":[ "schemas", "urn:ietf:params:scim:schemas:core:2.0:Group" ], "properties":{ "schemas":{ "description":"The Schemas to be included for the schema type.", "type":"array", "items":{ "type":"object", "enum":[ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group" ] } }, "urn:ietf:params:scim:schemas:core:2.0:Group":{ "$ref":"#/definitions/Core Group Properties" }, "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group":{ "$ref":"#/definitions/Oracle specific Group Properties" } } }, "POSTANDPUTRequest":{ "type":"object", "required":[ "schemas", "urn:ietf:params:scim:schemas:core:2.0:User" ], "properties":{ "schemas":{ "description":"The Schemas to be included for the schema type.", "type":"array", "items":{ "type":"object", "enum":[ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" ] } }, "urn:ietf:params:scim:schemas:core:2.0:User":{ "$ref":"#/definitions/Core User Properties" }, "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User":{ "$ref":"#/definitions/Oracle specific User Properties" }, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{ "$ref":"#/definitions/Enterprise specific User Properties" } } }, "PatchRequest":{ "type":"object", "required":[ "schemas", "Operations" ], "properties":{ "schemas":{ "description":"The schema for the Patch operation type", "default":[ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "type":"array", "items":{ "type":"string" } }, "Operations":{ "type":"array", "description":"Modifications (Patch operations) to be performed on the User.", "items":{ "$ref":"#/definitions/PatchOperation" } } } }, "PatchOperation":{ "type":"object", "required":[ "op", "path", "value" ], "properties":{ "op":{ "description":"The type of the Patch Operation.", "type":"string", "enum":[ "add", "delete", "replace" ] }, "path":{ "type":"string", "description":"The path of the entry attribute to be modified." }, "value":{ "type":"array", "description":"