Search Self-Registration Profiles Using POST

post

/admin/v1/SelfRegistrationProfiles/.search

Request

Supported Media Types
Header Parameters
  • The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
  • Media Type
  • 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.
Body ()
Root Schema : SelfRegistrationProfile-SearchRequest
Type: object
Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the /.search path extension. The inclusion of /.search on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in /.search). The body of the POST request MAY include any of the parameters.
Show Source
  • A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.
  • Allowed Values: [ "all", "always", "never", "request", "default" ]
    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. OPTIONAL.
  • Minimum Length: 1
    Maximum Length: 1000
    An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). OPTIONAL.
  • The filter string that is used to request a subset of resources. See the Using the Filter Query Parameter section of the Query Parameters page in Getting Started. The filter string MUST be a valid filter expression. See Section 3.4.2.2. OPTIONAL.
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:SearchRequest" ]
    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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.
  • A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation (Section 3.10) form. See Sorting section. OPTIONAL.
  • Allowed Values: [ "ascending", "descending" ]
    A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See (Sorting Section). OPTIONAL.
  • An integer that indicates the 1-based index of the first query result. See Pagination Section. OPTIONAL.
Back to Top

Response

Supported Media Types

200 Response

The request was successful.
Body ()
Root Schema : SelfRegistrationProfile-ListResponse
Type: object
The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI.
Show Source
  • The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.
  • Resources
    A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ]
    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. 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.
  • The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.
  • The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED.
Nested Schema : Resources
Type: array
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
Show Source
Nested Schema : SelfRegistrationProfile
Type: object
Self Registration Profile
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    A Boolean value that indicates whether Account verification email is required to be sent before login or not
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    A Boolean value that indicates whether the profile is enabled or not
  • afterSubmitText
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • idcsMultiLanguage: true
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Text to be displayed on UI after doing self registration
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A Multivalue String value for Email domains which are valid for this profile
  • consentText
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • idcsMultiLanguage: true
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Consent text
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    A boolean value that indicates whether the consent text is present.
  • defaultGroups
    SCIM++ Properties:
    • idcsCompositeKey: [value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    Default groups assigned to the user
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A Multivalue String Value for Email domains to be handled as exceptions
  • displayName
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • idcsMultiLanguage: true
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: complex
    • uniqueness: none
    Registration page name
  • emailTemplate
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: request
    • type: complex
    Email template
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.
  • Minimum Length: 1
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: reference
    References to footer logo
  • footerText
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • idcsMultiLanguage: true
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Footer text
  • Minimum Length: 1
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: reference
    Reference to header logo
  • headerText
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • idcsMultiLanguage: true
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Header text
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: always
    • type: string
    • uniqueness: global
    Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
  • idcsCreatedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    The User or App who created the Resource
  • idcsLastModifiedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    The User or App who modified the Resource
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    The release number when the resource was upgraded.
  • Allowed Values: [ "replace", "update", "delete" ]
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
  • meta
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: always
    • type: string
    • uniqueness: global
    Name of the profile
  • SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: integer
    • uniqueness: none
    Number of days redirect URL is valid
  • Minimum Length: 1
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    This URL will be replaced in email notification sent to user. When activation email required is set to true, user is created in \"pending verification\" state, upon clicking this link user will be able to activate himself. When activation email required is set to false, user is created in \"verified\" state, this link will be used to verify user's email.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    REQUIRED. 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 User, Group, and a standard \"enterprise\" extension. 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.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    A Boolean value that indicates whether the profile should be displayed on login page
  • tags
    SCIM++ Properties:
    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    A list of tags on this resource.
  • userAttributes
    SCIM++ Properties:
    • idcsCompositeKey: [value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    User Attributes
Nested Schema : afterSubmitText
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • idcsMultiLanguage: true
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Text to be displayed on UI after doing self registration
Show Source
Nested Schema : consentText
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • idcsMultiLanguage: true
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Consent text
Show Source
Nested Schema : defaultGroups
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
Default groups assigned to the user
Show Source
Nested Schema : displayName
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • idcsMultiLanguage: true
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: complex
  • uniqueness: none
Registration page name
Show Source
Nested Schema : emailTemplate
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: true
  • returned: request
  • type: complex
Email template
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    URI of the Email Template
  • Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A human readable name, primarily used for display purposes. READ-ONLY.
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Identifier of the Email Template.
Nested Schema : footerText
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • idcsMultiLanguage: true
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Footer text
Show Source
Nested Schema : headerText
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • idcsMultiLanguage: true
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Header text
Show Source
Nested Schema : idcsCreatedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex
The User or App who created the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who created this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who created this Resource
Nested Schema : idcsLastModifiedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
The User or App who modified the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who modified this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who modified this Resource
Nested Schema : meta
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
  • type: complex
A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The DateTime the Resource was added to the Service Provider
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Name of the resource type of the resource--for example, Users or Groups
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.
Nested Schema : tags
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [key, value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none
A list of tags on this resource.
Show Source
Nested Schema : userAttributes
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
User Attributes
Show Source
Nested Schema : afterSubmitText
Type: object
Text to be displayed on UI after doing self registration
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.
  • SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Type of user's locale e.g. en-CA
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Localized value of after submit text in corresponding locale
Nested Schema : consentText
Type: object
Consent text
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.
  • SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Type of user's locale e.g. en-CA
  • Minimum Length: 1
    Maximum Length: 10000
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Localized value of consent text in corresponding locale
Nested Schema : defaultGroups
Type: object
Default groups assigned to the user
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    URI of the Default Group
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A human readable name, primarily used for display purposes. READ-ONLY.
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Identifier of the Default Group.
Nested Schema : displayName
Type: object
Registration page name
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.
  • SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Type of user's locale e.g. en-CA
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Localized value of displayName in corresponding locale
Nested Schema : footerText
Type: object
Footer text
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.
  • SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Type of user's locale e.g. en-CA
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Localized value of footer text in corresponding locale
Nested Schema : headerText
Type: object
Header text
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.
  • SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Type of user's locale e.g. en-CA
  • Minimum Length: 1
    Maximum Length: 255
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Localized value of header text in corresponding locale
Nested Schema : tags
Type: object
A list of tags on this resource.
Show Source
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Key or name of the tag.
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Value of the tag.
Nested Schema : userAttributes
Type: object
User Attributes
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If this attribute can be deleted
  • SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Fully Qualified Attribute Name
  • Added In: 18.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Metadata of the user attribute
  • SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: integer
    • uniqueness: none
    Sequence Number for the attribute
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    name of the attribute

400 Response

Bad or invalid request
Body ()
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. Refer the available status codes here : Status Codes.
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
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • 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 : 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
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.
Body ()
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. Refer the available status codes here : Status Codes.
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
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • 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 : 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
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 could not be found.
Body ()
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. Refer the available status codes here : Status Codes.
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
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • 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 : 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
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.
Body ()
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. Refer the available status codes here : Status Codes.
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
  • A detailed, human readable message. OPTIONAL
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • 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 : 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
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.
Back to Top

Examples

The following example shows how to search for a self-registration profile by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.
curl
-X POST
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/SelfRegistrationProfiles/.search

Example of Request Body

The following shows an example of the request body in JSON format:

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "Resources": [
    {
      "redirectUrl": "https://tenant-url/ui/v1/verify",
      "headerLogo": "https://storage-url/v1/Storage-idcs2/52621C2CCADDDD9DCD350999F5792241B6C4A817EC9B4BE8982FC55FCA550499/files/201608300620/headerlogo.jpg",
      "idcsLastModifiedBy": {
        "type": "User",
        "value": "67d6a02962674f96905d833887e51917",
        "display": "admin opc",
        "$ref": "https://tenant-url/admin/v1/Users/67d6a02962674f96905d833887e51917"
      },
      "idcsCreatedBy": {
        "type": "User",
        "display": "admin opc",
        "value": "67d6a02962674f96905d833887e51917",
        "$ref": "https://tenant-url/admin/v1/Users/67d6a02962674f96905d833887e51917"
      },
      "showOnLoginPage": false,
      "id": "5d94b93915f540f5a8e21e25a45604d4",
      "activationEmailRequired": false,
      "consentTextPresent": true,
      "meta": {
        "created": "2015-07-13T07:28:59.227Z",
        "lastModified": "2015-07-13T07:28:59.227Z",
        "resourceType": "SelfRegistrationProfile",
        "location": "https://tenant-url/admin/v1/SelfRegistrationProfiles/5d94b93915f540f5a8e21e25a45604d4"
      },
      "active": true,
      "name": "OracleEmployees",
      "numberOfDaysRedirectUrlIsValid": 3,
      "allowedEmailDomains": [
        "all"
      ],
      "consentText": [
        {
          "default": true,
          "locale": "en-US",
          "value": "I agree to the terms of service"
        }
      ],
      "displayName": [
        {
          "default": true,
          "value": "OracleEmployees",
          "locale": "en-US"
        },
        {
          "value": "French version of 'OracleEmployees'",
          "locale": "fr"
        }
      ],
      "footerText": [
        {
          "default": true,
          "locale": "en-US",
          "value": "Oracle Corporation"
        },
        {
          "default": false,
          "locale": "fr",
          "value": "Oracle Corporation"
        }
      ],
      "headerText": [
        {
          "value": "Oracle Corporation",
          "default": true,
          "locale": "en-US"
        },
        {
          "value": "Oracle Corporation",
          "default": false,
          "locale": "fr"
        }
      ],
      "userAttributes": [
        {
          "value": "name.familyName",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:name.familyName",
          "seqNumber": 2
        },
        {
          "value": "password",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:password",
          "seqNumber": 7
        },
        {
          "value": "name.givenName",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:name.givenName",
          "seqNumber": 1
        },
        {
          "value": "emails.type",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:emails.type",
          "seqNumber": 3
        },
        {
          "value": "emails.value",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:emails.value",
          "seqNumber": 4
        },
        {
          "value": "emails.primary",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:emails.primary",
          "seqNumber": 5
        },
        {
          "value": "userName",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:userName",
          "seqNumber": 6
        },
        {
          "value": "costCenter",
          "deletable": true,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter",
          "seqNumber": 8
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:SelfRegistrationProfile"
      ]
    },
    {
      "headerLogo": "https://storage-url/v1/Storage-idcs2/52621C2CCADDDD9DCD350999F5792241B6C4A817EC9B4BE8982FC55FCA550499/files/201608300620/headerlogo.jpg",
      "redirectUrl": "https://tenant-url/ui/v1/verify",
      "idcsLastModifiedBy": {
        "type": "User",
        "value": "67d6a02962674f96905d833887e51917",
        "display": "admin opc",
        "$ref": "https://tenant-url/admin/v1/Users/67d6a02962674f96905d833887e51917"
      },
      "idcsCreatedBy": {
        "type": "User",
        "display": "admin opc",
        "value": "67d6a02962674f96905d833887e51917",
        "$ref": "https://tenant-url/admin/v1/Users/67d6a02962674f96905d833887e51917"
      },
      "showOnLoginPage": true,
      "id": "36d89625cb4a49deb351ac3bfcbc7ff4",
      "activationEmailRequired": true,
      "consentTextPresent": true,
      "meta": {
        "created": "2015-07-13T07:28:59.227Z",
        "lastModified": "2015-07-13T07:28:59.227Z",
        "resourceType": "SelfRegistrationProfile",
        "location": "https://tenant-url/admin/v1/SelfRegistrationProfiles/36d89625cb4a49deb351ac3bfcbc7ff4"
      },
      "active": true,
      "name": "OracleParters",
      "numberOfDaysRedirectUrlIsValid": 3,
      "footerLogo": "https://storage-url/v1/Storage-idcs2/52621C2CCADDDD9DCD350999F5792241B6C4A817EC9B4BE8982FC55FCA550499/files/201608300620/footerLogo.jpg",
      "afterSubmitText": [
        {
          "default": true,
          "value": "You have successfully registered yourself with ABCCorp as a partner. A welcome email has been sent for verification. To log in to the service, please click on the link.",
          "locale": "en-US"
        },
        {
          "default": false,
          "value": "French version of 'after submit text'",
          "locale": "fr"
        }
      ],
      "allowedEmailDomains": [
        "all"
      ],
      "consentText": [
        {
          "default": true,
          "locale": "en-US",
          "value": "I agree to the terms of service"
        },
        {
          "default": false,
          "value": "French version of 'consent text' terms and conditions",
          "locale": "fr"
        }
      ],
      "displayName": [
        {
          "default": true,
          "value": "OraclePartners",
          "locale": "en-US"
        },
        {
          "default": false,
          "value": "French version of 'OraclePartners'",
          "locale": "fr"
        }
      ],
      "footerText": [
        {
          "default": true,
          "locale": "en-US",
          "value": "Oracle Corporation"
        },
        {
          "default": false,
          "locale": "fr",
          "value": "french version of 'Oracle Corporation'"
        }
      ],
      "headerText": [
        {
          "value": "Oracle Corporation",
          "default": true,
          "locale": "en-US"
        },
        {
          "value": "french version of 'Oracle Corporation'",
          "default": false,
          "locale": "fr"
        }
      ],
      "userAttributes": [
        {
          "value": "name.familyName",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:name.familyName",
          "seqNumber": 2
        },
        {
          "value": "password",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:password",
          "seqNumber": 7
        },
        {
          "value": "name.givenName",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:name.givenName",
          "seqNumber": 1
        },
        {
          "value": "emails.type",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:emails.type",
          "seqNumber": 3
        },
        {
          "value": "emails.value",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:emails.value",
          "seqNumber": 4
        },
        {
          "value": "emails.primary",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:emails.primary",
          "seqNumber": 5
        },
        {
          "value": "userName",
          "deletable": false,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:core:2.0:User:userName",
          "seqNumber": 6
        },
        {
          "value": "employeeNumber",
          "deletable": true,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber",
          "seqNumber": 9
        },
        {
          "value": "employeeNumber",
          "deletable": true,
          "fullyQualifiedAttributeName": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber",
          "seqNumber": 8
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:SelfRegistrationProfile"
      ]
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 50
}
Back to Top