Retrieve My Profile
/mobile/platform/users/me
Retrieves the currently authorized user's profile.
- When the user is a mobile user, this operation retrieves the user's profile.
- When the user is a virtual user, this operation retrieves the user name and roles.
- When the user is a social user (that is, signed in using social identity), this operation retrieves the user's mobile ID.
Permissions
The authorized user can be a social user, virtual user, or a mobile user. If the authorized user is a mobile user, then the user must have a role that's associated with the mobile backend.
Request
There are no request parameters for this operation.
Back to TopResponse
- application/json
200 Response
object
User Information/User Profile
-
object User Profile
Title:
User Profile
Additional Properties Allowed:true
User identity information that follows the System for Cross-Domain Identity Management (SCIM) standard. -
object Virtual User Information
Title:
Virtual User Information
Information that's returned when the current user is a virtual user. -
object Social User Information
Title:
Social User Information
Additional Properties Allowed:true
Information that's returned when the current user is a social user (that is, signed in using social identity).
object
User Profile
true
-
active(optional):
boolean
A Boolean value indicating whether the user is active.
-
addresses(optional):
array addresses
Physical mailing addresses for the user, such as work, home, and other.
-
displayName(optional):
string
Minimum Length:
2
Maximum Length:150
The display name. -
emails:
array emails
A complex attribute that represents emails.
-
entitlements(optional):
array entitlements
A list of entitlements for the user.
-
externalId(optional):
string
A user-provided identifier for the resource.
-
groups(optional):
array groups
A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamic calculation.
-
id:
string
Unique identifier for the SCIM resource.
-
idcsCreatedBy:
object Created By
Title:
Created By
The user or app that created this resource. -
idcsLastModifiedBy(optional):
object Last Modified By
Title:
Last Modified By
The user or app that modified this resource. -
ims(optional):
array ims
The user's instant messaging addresses.
-
locale(optional):
string
Minimum Length:
1
Maximum Length:50
The user's default location for purposes of localizing items such as currency, date and time format, and numerical representations. -
meta(optional):
object Metadata
Title:
Metadata
A complex object that contains the resource's metadata. All sub-attributes are optional. -
name:
object Full Name
Title:
Full Name
A complex object that contains attributes that represent the user's full name. -
nickName(optional):
string
Minimum Length:
5
Maximum Length:100
The user's nick name. -
password(optional):
string
Minimum Length:
1
Maximum Length:500
The user's password. -
phoneNumbers(optional):
array phoneNumbers
A list of the user's phone numbers.
-
photos(optional):
array photos
A list of URLs of photos for the user.
-
preferredLanguage(optional):
string
Minimum Length:
1
Maximum Length:50
The user's preferred written or spoken language, which is used for localized user interfaces. -
profileUrl(optional):
string
Minimum Length:
1
Maximum Length:2000
A fully-qualified URL to a page that represents the user's online profile. -
roles(optional):
array roles
A list of roles for the user that collectively represent who the user is.
-
schemas:
string
REQUIRED. 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 is a unique URI. This specification defines URIs for user and group, and a standard enterprise extension.
-
timezone(optional):
string
Minimum Length:
1
Maximum Length:50
The user's timezone. -
title(optional):
string
Minimum Length:
1
Maximum Length:50
The user's title. -
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User(optional):
object Enterprise
Title:
Enterprise
Enterprise user information. -
urn:ietf:params:scim:schemas:oracle:idcs:extension:crossSso:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:crossSso:User
This extension defines attributes to manage the user account for cross-tenant SSO.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:me:User(optional):
object IDCS Self-Service Extension
Title:
IDCS Self-Service Extension
IDCS self-service schema extension. -
urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User(optional):
object Multi-Factor Authentication
Title:
Multi-Factor Authentication
This extension defines attributes that are used to manage multi-factored authentication (MFA). -
urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User
This extension defines attributes that are used to manage account passwords.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User(optional):
object POSIX
Title:
POSIX
POSIX user extension. -
urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User(optional):
object Security Question Extension
Title:
Security Question Extension
This extension defines attributes used to store the user's security questions. -
urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User(optional):
object Self-Registration
Title:
Self-Registration
This extension defines attributes used to manage the self-registration profile linked to the user. -
urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User(optional):
object IDCS User Information
Title:
IDCS User Information
Identity Cloud Serice (IDCS) user information. -
urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User
This extension defines the attributes that are used to manage account passwords.
-
userName:
string
Minimum Length:
3
Maximum Length:100
The user name. -
userType(optional):
string
Allowed Values:
[ "Contractor", "Employee", "Intern", "Temp", "External", "Service" ]
The organization-to-user relationship. -
x509Certificates(optional):
array x509Certificates
A list of x509 certificates issued to the user.
object
Virtual User Information
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User:
object User Roles
Title:
User Roles
The user's application roles. -
userName:
string
Pattern:
[a-zA-Z0-9][a-zA-Z0-9\-_\.\@]*
The user name for the user.
array
-
Array of:
object Physical Mailing Address
Title:
Physical Mailing Address
A complex attribute that represents the user's physical mailing address, such as a work address or home address.
array
-
Array of:
object Email Address
Title:
Email Address
A complex attribute that represents an email address.
array
-
Array of:
object User's Entitlement
Title:
User's Entitlement
A complex attribute that represents an entitlement that the user has.
array
-
Array of:
object Group
Title:
Group
A group that the user belongs to, either thorough direct membership, nested groups, or dynamic calculation.
object
Created By
-
$ref(optional):
string
The user or app that created this resource.
-
display(optional):
string
The display name of the user or app that created this resource.
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
The type of resource,User
orApp
, that created this resource. -
value(optional):
string
The ID of the SCIM resource that represents the user or app that created this resource.
object
Last Modified By
-
$ref(optional):
string
The URI of the SCIM resource that represents the user or app that modified this resource.
-
display(optional):
string
The display name of the the user or app that modified this resource.
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
The type of resource,User
orApp
, that modified this resource. -
value(optional):
string
The ID of the SCIM resource that represents the user or app that modified this resource.
array
-
Array of:
object Instant Messaging Service (IMS) Address
Title:
Instant Messaging Service (IMS) Address
A complex attribute that represents an IMS address.
object
Metadata
-
created(optional):
string
The date and time, in DateTime format, that the resource was added.
-
lastModified(optional):
string
The most recent date and time, in DateTime format, that the details of this resource were updated. If this resource has never been modified since its initial creation, then the value is the same as the
created
value. -
location(optional):
string
The URI of the returned resource.
-
resourceType(optional):
string
Type of resource. For example,
Users
orGroups
. -
version(optional):
string
The version of the returned resource.
object
Full Name
-
familyName(optional):
string
Minimum Length:
1
Maximum Length:50
The user's last name. -
formatted(optional):
string
Minimum Length:
1
Maximum Length:256
The user's full name. -
givenName(optional):
string
Minimum Length:
1
Maximum Length:50
The user's first name. -
honorificPrefix(optional):
string
Minimum Length:
1
Maximum Length:25
Honorific that prefixes the user's name. -
honorificSuffix(optional):
string
Minimum Length:
1
Maximum Length:25
Honorific that suffixes the user's name. -
middleName(optional):
string
Minimum Length:
1
Maximum Length:100
The user's middle name.
array
-
Array of:
object phoneNumbers
A complex attribute that represents a phone number.
array
-
Array of:
object Photo URL
Title:
Photo URL
A complex attribute that represents a photo URL.
array
-
Array of:
object Role
Title:
Role
A complex attribute that represents a role that's been granted to the user.
object
Enterprise
-
costCenter(optional):
string
Minimum Length:
1
Maximum Length:50
The name of a cost center. -
department(optional):
string
Minimum Length:
1
Maximum Length:50
The name of a department. -
division(optional):
string
Minimum Length:
1
Maximum Length:50
The name of a division. -
employeeNumber(optional):
string
Minimum Length:
1
Maximum Length:50
A numeric or alphanumeric identifier that's assigned to a person. -
manager(optional):
object Manager
Title:
Manager
The user's manager. A complex type that optionally allows representation of an organizational hierarchy by referencing theid
attribute of another user. -
organization(optional):
string
Minimum Length:
1
Maximum Length:50
The name of an organization.
object
object
IDCS Self-Service Extension
-
currentPassword(optional):
string
Minimum Length:
1
Maximum Length:500
The current password is required if the user attempts to change the values of attributes that are used in recovering or verifying the user's own identity. If the current password is specified, it's used to authenticate the user regardless of any change in these attribute values.
object
Multi-Factor Authentication
-
bypassCodes(optional):
array bypassCodes
A list of bypass codes that belong to the user.
-
devices(optional):
array devices
A list of devices that belong to the user.
-
loginAttempts(optional):
integer
The number of incorrect multi-factor authentication login attempts that the user made. The user is locked if this reaches the threshold specified in the
maxIncorrectAttempts
attribute inAuthenticationFactorSettings
. -
mfaStatus(optional):
string
Allowed Values:
[ "ENROLLED", "IGNORED", "UN_ENROLLED", "DISABLED" ]
The user's opted-in status for multi-factor authentication (MFA). -
preferredAuthenticationFactor(optional):
string
Minimum Length:
1
Maximum Length:40
Allowed Values:[ "SMS", "TOTP", "PUSH", "OFFLINETOTP", "SECURITY_QUESTIONS", "VOICE" ]
The preferred authentication factor type. -
preferredDevice(optional):
object preferredDevice
The user's preferred device.
-
trustedUserAgents(optional):
array trustedUserAgents
A list of the trusted user agents that the user owns. Multi-factored authentication uses trusted user agents to authenticate users. A user agent is a software application that a user uses to issue requests. For example, a user agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, one of several executing on a particular mobile device). A user agent is trusted once the multi-factored authentication has verified it in some way.
object
object
POSIX
-
gecos(optional):
string
General information about the POSIX account such as the account owner's real name and phone number.
-
gidNumber(optional):
integer
The primary group identifier of the POSIX user.
-
homeDirectory(optional):
string
The absolute path to the home directory of the POSIX account.
-
loginShell(optional):
string
The path to the login shell of the POSIX account.
object
Security Question Extension
-
secQuestions(optional):
array secQuestions
The security questions and answers that were provided by the end-user for account recovery and/or multi-factor authentication (MFA). While setting up security questions, the end-user can also provide a hint along with the answer.
object
Self-Registration
-
consentGranted(optional):
boolean
A boolean value that indicates whether the consent is granted.
-
selfRegistrationProfile(optional):
object selfRegistrationProfile
The self-registration profile that's used when the user is self-registered.
object
IDCS User Information
-
accounts(optional):
array accounts
A list of accounts that are assigned to the user.
-
appRoles(optional):
array appRoles
A list of the user's application roles. These roles may have been assigned thorough direct membership and nested groups, or were dynamically calculated.
-
bypassNotification(optional):
boolean
A Boolean value that indicates whether to send an email notification after creating the user. Update and replace operations don't use this attribute.
-
creationMechanism(optional):
string
Allowed Values:
[ "bulk", "api", "adsync", "idcsui", "import", "selfreg" ]
The user creation mechanism. -
doNotShowGettingStarted(optional):
boolean
A Boolean value that indicates whether to hide the getting started page.
-
grants(optional):
array grants
A list of the grants that are assigned to the user.
-
internalName(optional):
string
Minimum Length:
1
Maximum Length:100
The internal user name. -
isFederatedUser(optional):
boolean
A Boolean value that indicates whether the user is federated.
-
provider(optional):
string
Allowed Values:
[ "facebook", "google", "IDCS", "twitter" ]
The registration provider.
object
array
-
Array of:
object x509 Certificate
Title:
x509 Certificate
A complex attribute that represents a certificate that's been issued to the user.
object
Physical Mailing Address
-
country(optional):
string
Minimum Length:
1
Maximum Length:50
The name of the country. -
formatted(optional):
string
Minimum Length:
1
Maximum Length:500
The full mailing address that's formatted for display or a mailing label. The value can contain newline characters. -
locality(optional):
string
Minimum Length:
1
Maximum Length:50
The city or locality. -
postalCode(optional):
string
Maximum Length:
50
The zipcode or postal code. -
primary(optional):
boolean
A Boolean value that indicates the primary or preferred address. Only one address may have this value set to `true`.
-
region(optional):
string
Minimum Length:
1
Maximum Length:100
The state or region. -
streetAddress(optional):
string
Minimum Length:
1
Maximum Length:200
The full street address component, which can include the house number, street name, PO Box, and multi-line extended street address information. The value can contain newline characters. -
type:
string
Allowed Values:
[ "work", "home", "other" ]
A label that indicates the address's function. For example, 'work' or 'home'.
object
Email Address
-
primary(optional):
boolean
A Boolean value that indicates whether the email address is the primary email address. Only one email address may have this value set to
true
. -
type:
string
Allowed Values:
[ "work", "home", "other", "recovery" ]
The type of email address -
value:
string
Minimum Length:
5
Maximum Length:100
An email address.
object
User's Entitlement
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
A human-readable name, which is primarily used for display purposes. -
primary(optional):
boolean
A Boolean value that indicates the primary or preferred entitlement. Only one entitlement may have this value set to `true`.
-
type:
string
A label that indicates the entitlement's function.
-
value:
string
Minimum Length:
1
Maximum Length:100
The value of an entitlement.
object
Group
-
$ref(optional):
string
The URI of the corresponding group resource to which the user belongs.
-
display(optional):
string
A human-readable name, which is primarily used for display purposes. READ-ONLY.
-
type(optional):
string
Allowed Values:
[ "direct", "indirect" ]
A label that indicates the group's function. For example, 'direct' or 'indirect'. -
value:
string
The identifier of the group.
object
Instant Messaging Service (IMS) Address
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
A human-readable name, which is primarily used for display purposes. -
primary(optional):
boolean
A Boolean value that indicates the primary or preferred IM addess. Only one IM address may have this value set to `true`.
-
type:
string
Allowed Values:
[ "aim", "gtalk", "icq", "xmpp", "msn", "skype", "qq", "yahoo" ]
A label that indicates the IM address's function. For example, `aim`, `gtalk`, or `mobile` -
value:
string
Minimum Length:
1
Maximum Length:100
The user's instant messaging address.
object
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
A human-readable name, which is primarily used for display purposes. READ ONLY -
primary(optional):
boolean
A Boolean value that indicates the whether this number is the preferred or primary phone number. Only one phone number may have this value set to
true
. -
type:
string
Allowed Values:
[ "work", "home", "mobile", "fax", "pager", "other", "recovery" ]
A label that indicates the phone number's function. For example,work
,home
, ormobile
. -
value:
string
Minimum Length:
1
Maximum Length:100
The user's phone number. -
verified(optional):
boolean
A Boolean value that indicates if the phone number is verified.
object
Photo URL
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
A human-readable name, which is primarily used for display purposes. -
primary(optional):
boolean
A Boolean value that indicates the primary or preferred photo. Only one photo may have this value set to
true
. -
type:
string
Allowed Values:
[ "photo", "thumbnail" ]
A label that indicates the photo's function. For example,photo
orthumbnail
. -
value:
string
Minimum Length:
1
Maximum Length:2000
The URL of a photo for the user.
object
Role
-
display(optional):
string
A human-readable name, which is primarily used for display purposes.
-
primary(optional):
boolean
A Boolean value that indicates the primary or preferred role. Only one role may have this value set to `true`.
-
type:
string
A label that indicates the role's function.
-
value:
string
Maximum Length:
100
The value of the role.
object
Manager
id
attribute of another user.-
$ref(optional):
string
The URI of the SCIM resource that represents the user's manager. RECOMMENDED.
-
displayName(optional):
string
The display name of the user's manager. OPTIONAL and READ-ONLY.
-
value(optional):
string
Minimum Length:
1
Maximum Length:40
The identifier of the resource (that follows the SCIM standard), that represents the user's manager. RECOMMENDED.
array
-
Array of:
object Bypass Code
Title:
Bypass Code
The user's bypass code.
array
-
Array of:
object User Device
Title:
User Device
A device that belongs to the user.
object
-
$ref(optional):
string
The URI that corresponds to the device resource.
-
value(optional):
string
The identifier of the user's preferred device
array
-
Array of:
object Trusted User Agent
Title:
Trusted User Agent
Multi-factored authentication uses trusted user agents to authenticate users. A user agent is a software application that a user uses to issue requests. For example, a user agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, one of several executing on a particular mobile device). A user agent is trusted once the multi-factored authentication has verified it in some way.
object
Bypass Code
-
$ref(optional):
string
The URI of the corresponding `BypassCode` resource that belongs to the user.
-
value:
string
The identifier of the user's bypass code.
object
User Device
-
$ref(optional):
string
The URI of the corresponding device resource the belongs to the user.
-
display(optional):
string
A human-readable name, which is primarily used for display purposes. READ-ONLY.
-
value:
string
The identifier of the user's device.
object
Trusted User Agent
-
$ref(optional):
string
The URI of the corresponding trusted user agent resource.
-
display(optional):
string
A human-readable identifier for this trusted user agent, which is used primarily for display purposes. READ-ONLY.
-
value:
string
The identifier of the user's trusted user agent.
array
-
Array of:
object Security Question
Title:
Security Question
Security question and answer for account recovery and/or multi-factor authentication (MFA). While setting up security questions, you can also provide a hint along with the answer.
object
Security Question
-
$ref(optional):
string
The URI of the corresponding `SecurityQuestion` resource
-
answer:
string
Minimum Length:
1
Maximum Length:500
The answer provided by the user for the security question. -
hintText(optional):
string
The user-provided hint for the answer.
-
value:
string
The ID of the question that was selected by the user while setting up the security question.
object
-
$ref(optional):
string
The URI of the profile.
-
display(optional):
string
A human-readable name, which is primarily used for display purposes. READ-ONLY.
array
-
Array of:
object User Account
Title:
User Account
A complex attribute that represents an account that's been assigned to the user.
array
-
Array of:
object Application Role
Title:
Application Role
An application role that's been granted to the user, either thorough direct membership, nested groups, or dynamic calculation.
array
-
Array of:
object Grant
Title:
Grant
A grant that's been assigned to the user.
object
User Account
-
$ref(optional):
string
Account management information URI.
-
appId(optional):
string
The application identifier.
-
value(optional):
string
The account identifier.
object
Application Role
-
$ref(optional):
string
The URI of the corresponding `appRole` resource to which the user belongs
-
adminRole(optional):
boolean
If true, then the role provides administrative access privileges. READ-ONLY.
-
appId(optional):
string
The ID of the parent app. READ-ONLY.
-
appName(optional):
string
The name of parent app. READ-ONLY.
-
display(optional):
string
A human-readable name, which is primarily used for display purposes. READ-ONLY.
-
legacyGroupName(optional):
string
The name of the legacy group that's associated with this `AppRole`.
-
type(optional):
string
Allowed Values:
[ "direct", "indirect" ]
A label that indicates the role's function, such as `direct` or `indirect`. -
value(optional):
string
The identifier of the role.
object
Grant
-
$ref(optional):
string
The grant's URI.
-
appId(optional):
string
The app identifier.
-
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" ]
Indicates how (or by what component) some app (or app entitlement) was granted.
A customer or the UI should use only the 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
The grant identifier.
object
x509 Certificate
-
display(optional):
string
A human-readable name, which is primarily used for display purposes.
-
primary(optional):
boolean
A Boolean value that indicates the primary or preferred certificate. Only one certificate may have this value set to `true`.
-
type(optional):
string
A label that indicates the certificate's function.
-
value:
object value
The value of an X509 certificate.
object
object
User Roles
-
appRoles(optional):
array appRoles
A list of the user's application roles. These roles may have been assigned thorough direct membership and nested groups, or were dynamically calculated.
array
-
Array of:
object Virtual User Application Role
Title:
Virtual User Application Role
An application role that's been granted to a virtual user.
object
Virtual User Application Role
-
display:
string
A human-readable name, which is primarily used for display purposes.
400 Response
The operation can't be performed.
-
Content-Type: string
The media type of the error message, which is
application/json
.
object
Error
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
array
0
-
Array of:
object Error Detail
Title:
Error Detail
object
Error Detail
-
instance:
string
URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
The service's error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
{
"o:errorCode":"MOBILE-58060",
"detail":"Unable to use API virtualization for calls without any mobile backend context.",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Cannot call API",
"o:errorPath":"/mobile/platform/users/joe",
"o:ecid":"cde040005cd5983e:4372d958:14c8c4c2d6c:-8000-000000000032b9d5, 0",
"status":400
}
401 Response
The operation can't be performed due to one of the following reasons:
- The user doesn't exist.
- The password is incorrect.
- The
Authorization
HTTP request header wasn't specified. - The user name doesn't match the user name in the
Authorization
HTTP request header.
-
Content-Type: string
The media type of the error message, which is
application/json
.
object
Error
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
array
0
-
Array of:
object Error Detail
Title:
Error Detail
object
Error Detail
-
instance:
string
URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
The service's error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
{
"o:errorCode":"MOBILE-15209",
"detail":"401 - Unauthorized",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Unauthorized",
"o:errorPath":"/mobile/platform/users/joe",
"o:ecid":"cde040005cd5983e:4372d958:14c8c4c2d6c:-8000-000000000033b51c, 0",
"status":401
}
403 Response
The operation can't be performed due to one of the following reasons:
- The user doesn't have a role that's associated with the mobile backend.
- The value of the
Authorization
HTTP request header that follows either theBearer
orBasic
authentication scheme is either missing or invalid.
406 Response
The MIME media type isn't supported. Only application/json
is supported. Either remove the Accept
header or specify a media type that's supported.
-
Content-Type: string
The media type of the error message, which is
application/json
.
object
Error
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
array o:errorDetails
Minimum Number of Items:
0
Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
array
0
-
Array of:
object Error Detail
Title:
Error Detail
object
Error Detail
-
instance:
string
URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
The service's error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
{
"o:errorCode":"MOBILE-92516",
"detail":"The MIME media type isn't supported, only application/json is supported. Either remove the Accept header or specify a media type that is supported.",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Unsupported media type",
"o:errorPath":"/mobile/platform/users/joe",
"o:ecid":"cde040005cd5983e:4372d958:14c8c4c2d6c:-8000-000000000033ddba, 0",
"status":406
}
Examples
The following example shows how to get the currently authorized user's profile.
curl -i -X GET -u jdoe:password -H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" https://fif.cloud.oracle.com/mobile/platform/users/me
Example of Response Header
The following shows an example of the response header.
200 OK Content-Type: application/json Date: Mon, 28 Jan 2019 18:08:57 GMT
Example of Response Body for an IDCS User
The following example shows, in JSON format, the contents of the response body:
{
"idcsCreatedBy":{
"type":"User",
"display":"admin opc",
"value":"ABCD6996a13b1641eca66fbf4c75af42",
"$ref":"https://example.com:443/admin/v1/Apps/ABCD6996a13b1641eca66fbf4c75af42"
},
"id":"ABCD5f2a5eb5e1664cbc94fc651a8562",
"active":true,
"displayName":"Doe Joe",
"idcsLastModifiedBy":{
"value":"ABCD5316fb6146d1bb3b60b75363",
"display":"idcssso",
"type":"App",
"$ref":"https://example.com:443/admin/v1/Apps/ABCD5316fb6146d1bb3b60b75363"
},
"userName":"jdoe",
"urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User":{
"isFederatedUser":false,
"grants":[
{
"appId":"c6a3a4174e8a4975b688f43e8aaace18",
"grantMechanism":"ADMINISTRATOR_TO_USER",
"value":"273979318ee2482bba40a44142a6c90a",
"$ref":"https://example.com:443/admin/v1/Grants/273979318ee2482bba40a44142a6c90a"
}
],
"appRoles":[
{
"value": "49b2abb5795947baafb907d15ba6d9ad",
"adminRole": false,
"legacyGroupName": "ABCD29F71D52E41B49EBD6F895FDA.FIF_TECHNICIAN",
"appId": "ABCD220aeebc14937b4b82df71671",
"appName": "ABCD2F71D52E41B49EBD6F895FDA_APPID",
"display": "FIF_TECHNICIAN",
"$ref":"https://example.com:443/admin/v1/AppRoles/49b2abb5795947baafb907d15ba6d9ad"
},
{
"value": "e613ab16da364ecd99cffa97fe2d24a2",
"adminRole": false,
"legacyGroupName": "ABCD29F71D52E41B49EBD6F895FDA.Mobile Notifications",
"appId": "ABCD220aeebc14937b4b82df71671",
"appName": "ABCD2F71D52E41B49EBD6F895FDA_APPID",
"display": "Mobile Notifications",
"$ref": "https://example.com:443/admin/v1/AppRoles/e613ab16da364ecd99cffa97fe2d24a2"
}
],
"accounts":[
{
"value":"125daaab1e7e47b995232f51516544c6",
"appId":"c6a3a4174e8a4975b688f43e8aaace18",
"$ref":"https://example.com:443/admin/v1/AccountMgmtInfos/125daaab1e7e47b995232f51516544c6"
}
]
},
"emails":[
{
"type":"recovery",
"primary":false,
"value":"jdoe@example.invalid",
"verified":false
},
{
"type":"work",
"primary":true,
"value":"jdoe@example.invalid",
"verified":false
}
],
"name":{
"givenName":"Joe",
"familyName":"Doe",
"formatted":"Joe Doe"
},
"urn:ietf:params:scim:schemas:idcs:extension:custom:User": {
"custom_attribute": "1076270704"
},
"schemas":[
"urn:ietf:params:scim:schemas:core:2.0:User"
]
}
Example of Response Body for a Social User
The following example shows, in JSON format, the contents of the response body when the current user is a social user:
{ "userName": "1 :623:165" }
Example of Response Body for a Virtual User
The following example shows, in JSON format, the contents of the response body when the current user is a virtual user:
{
"userName":"jdoe",
"urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User":{
"appRoles":[
{
"display":"FIF_TECHNICIAN"
}
]
}
}