Get a Group
get
/admin/v1/Groups/{id}
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of the resource
Query Parameters
-
attributeSets(optional): string
A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.Allowed Values:
[ "all", "always", "never", "request", "default" ]
-
attributes(optional): string
A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
Header Parameters
-
Authorization: string
The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
-
Content-Type: string
Media Type
-
RESOURCE_TYPE_SCHEMA_VERSION(optional): string
An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Response
Supported Media Types
- application/json
- application/scim+json
200 Response
The request was successful.
Root Schema : Group
Type:
object
Group resource.
Show Source
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
deleteInProgress(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
displayName:
string
Minimum Length:
1
Maximum Length:3000
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Display Name
- idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: global
-
domainOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
id(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: global
-
idcsCreatedBy:
object idcsCreatedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
idcsLastModifiedBy(optional):
object idcsLastModifiedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
idcsLastUpgradedInRelease(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
idcsPreventedOperations(optional):
array idcsPreventedOperations
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
members(optional):
array members
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members[User].value, multiValueDelimiter:;]]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
meta(optional):
object meta
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
- type: complex
-
nonUniqueDisplayName(optional):
string
Minimum Length:
1
Maximum Length:3000
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Non-Unique Display Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
-
ocid(optional):
string
Maximum Length:
255
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: string
- uniqueness: global
-
schemas:
array schemas
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
tags(optional):
array tags
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
tenancyOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:dbcs:Group(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:dbcs:Group
Schema for Database Service Resource
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:dynamic:Group(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:dynamic:Group
Dynamic Group
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group
Idcs Group
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags
OCI Tags.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group
POSIX Group extension
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:requestable:Group(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:requestable:Group
Requestable Group
Nested Schema : idcsCreatedBy
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsLastModifiedBy
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsPreventedOperations
Type:
array
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"replace",
"update",
"delete"
]
Nested Schema : members
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [value]
- idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members[User].value, multiValueDelimiter:;]]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object members
AppRole members
Nested Schema : meta
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
- type: complex
-
created(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
lastModified(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
location(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
resourceType(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
version(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : schemas
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:dbcs:Group
Type:
object
Schema for Database Service Resource
Show Source
-
domainLevelSchema(optional):
string
Added In: 18.2.4
SCIM++ Properties:- idcsSearchable: false
- idcsSensitive: none
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
domainLevelSchemaNames(optional):
array domainLevelSchemaNames
Added In: 18.2.4
SCIM++ Properties:- idcsCompositeKey: [domainName, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
instanceLevelSchema(optional):
string
Added In: 18.2.4
SCIM++ Properties:- idcsSearchable: false
- idcsSensitive: none
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
instanceLevelSchemaNames(optional):
array instanceLevelSchemaNames
Added In: 18.2.4
SCIM++ Properties:- idcsCompositeKey: [dbInstanceId, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:dynamic:Group
Type:
object
Dynamic Group
Show Source
-
membershipRule(optional):
string
Maximum Length:
4000
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
membershipType(optional):
string
Maximum Length:
40
Allowed Values:[ "static", "dynamic" ]
Added In: 19.2.1
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:group:Group
Type:
object
Idcs Group
Show Source
-
appRoles(optional):
array appRoles
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
creationMechanism(optional):
string
Allowed Values:
[ "bulk", "api", "adsync", "authsync", "idcsui", "import" ]
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeNameMappings: [[defaultValue:import]]
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: request
- type: string
- uniqueness: none
-
description(optional):
string
Maximum Length:
4000
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Description
- idcsCsvAttributeNameMappings: [[columnHeaderName:Description]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
grants(optional):
array grants
SCIM++ Properties:
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
owners(optional):
array owners
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value, type]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
passwordPolicy(optional):
object passwordPolicy
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
syncedFromApp(optional):
object syncedFromApp
Added In: 18.4.2
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags
Type:
object
OCI Tags.
Show Source
-
definedTags(optional):
array definedTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
-
freeformTags(optional):
array freeformTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
-
tagSlug(optional):
object tagSlug
Added In: 2011192329
SCIM++ Properties:- type: binary
- mutability: readOnly
- returned: request
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:Group
Type:
object
POSIX Group extension
Show Source
-
gidNumber(optional):
integer
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: integer
- uniqueness: server
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:requestable:Group
Type:
object
Requestable Group
Show Source
-
requestable(optional):
boolean
Added In: 17.3.4
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- idcsCsvAttributeNameMappings: [[columnHeaderName:Requestable, mapsTo:requestable]]
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: boolean
- uniqueness: none
Nested Schema : members
Type:
object
AppRole members
Show Source
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
Maximum Length:
40
Allowed Values:[ "User", "Group", "DynamicResourceGroup" ]
SCIM++ Properties:- caseExact: true
- idcsCsvAttributeName: Member Type
- idcsDefaultValue: User
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
SCIM++ Properties:- caseExact: true
- idcsCsvAttributeName: Member
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : domainLevelSchemaNames
Type:
array
Added In: 18.2.4
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [domainName, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
Array of:
object domainLevelSchemaNames
Added In: 18.2.4
SCIM++ Properties:- idcsCompositeKey: [domainName, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
Nested Schema : instanceLevelSchemaNames
Type:
array
Added In: 18.2.4
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [dbInstanceId, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
Array of:
object instanceLevelSchemaNames
Added In: 18.2.4
SCIM++ Properties:- idcsCompositeKey: [dbInstanceId, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
Nested Schema : domainLevelSchemaNames
Type:
object
Added In: 18.2.4
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [domainName, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
domainName:
string
Added In: 18.2.4
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
schemaName:
string
Added In: 18.2.4
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : instanceLevelSchemaNames
Type:
object
Added In: 18.2.4
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [dbInstanceId, schemaName]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
dbInstanceId:
string
Added In: 18.2.4
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
schemaName:
string
Added In: 18.2.4
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : appRoles
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object appRoles
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : grants
Type:
array
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object grants
Grants assigned to the app
Nested Schema : owners
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [value, type]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object owners
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value, type]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : passwordPolicy
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
name(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
priority(optional):
integer
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
- uniqueness: none
-
value:
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : syncedFromApp
Type:
object
Added In: 18.4.2
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 18.4.2
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
Maximum Length:
40
Allowed Values:[ "App" ]
Added In: 18.4.2
SCIM++ Properties:- idcsDefaultValue: App
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 18.4.2
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : appRoles
Type:
object
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
adminRole(optional):
boolean
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
appId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
appName(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
legacyGroupName(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "direct", "indirect", "implicit" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : grants
Type:
object
Grants assigned to the app
Show Source
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
granteeId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
granteeType(optional):
string
Allowed Values:
[ "User", "Group" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
grantMechanism(optional):
string
Allowed Values:
[ "IMPORT_APPROLE_MEMBERS", "ADMINISTRATOR_TO_USER", "ADMINISTRATOR_TO_GROUP", "SERVICE_MANAGER_TO_USER", "ADMINISTRATOR_TO_APP", "SERVICE_MANAGER_TO_APP", "OPC_INFRA_TO_APP", "GROUP_MEMBERSHIP" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.
A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':
- 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.
- 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.
- 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : owners
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [value, type]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: true
- idcsDefaultValue: User
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : definedTags
Type:
array
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
-
Array of:
object definedTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
Nested Schema : freeformTags
Type:
array
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
-
Array of:
object freeformTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
Nested Schema : tagSlug
Type:
object
Maximum Length:
4001
Added In: 2011192329
SCIM++ Properties:
SCIM++ Properties:
- type: binary
- mutability: readOnly
- returned: request
Nested Schema : definedTags
Type:
object
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
-
key:
string
Maximum Length:
100
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- type: string
- required: true
- mutability: readWrite
- returned: default
- idcsSearchable: true
- uniqueness: none
-
namespace:
string
Maximum Length:
100
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- type: string
- required: true
- mutability: readWrite
- returned: default
- idcsSearchable: true
- uniqueness: none
-
value:
string
Maximum Length:
256
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- required: true
- mutability: readWrite
- returned: default
- type: string
- idcsSearchable: true
- uniqueness: none
Nested Schema : freeformTags
Type:
object
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
-
key:
string
Maximum Length:
100
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- type: string
- required: true
- mutability: readWrite
- returned: default
- idcsSearchable: true
- uniqueness: none
-
value:
string
Maximum Length:
256
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- required: true
- mutability: readWrite
- returned: default
- type: string
- idcsSearchable: true
- uniqueness: none
400 Response
Bad or invalid request
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
401 Response
The supplied credentials, if any, are not sufficient to access the resource.
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
404 Response
The requested resource was not found.
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
500 Response
We couldn't return the representation due to an internal server error.
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.