Jump to

• Request
• Response

Retrieve Extended User Information

get

/mobile/platform/extended/users/{username}

Retrieves information about the current authorized user, including the user's roles.

• When the user is an MCS mobile user, this operation retrieves the user name, first name, last name, roles, and email address as well as the custom properties that were added to the realm that the user belongs to.
• 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 MCS ID, identity provider, and access token.

If you don't know the user name, then use ~ for the username path parameter to indicate the current user.

For security reasons, you can call this operation only from custom API implementations by using the custom code SDK. You can't make direct requests from client applications. This API is included in this reference merely to describe the request and response bodies for the custom code SDK calls.

Permissions

The authorized user must be either an MCS mobile user that is a member of the realm that is associated with the mobile backend or a virtual or social user.

Request

Path Parameters

• username: string

  The user name of the client applicaton user, which is the user in the Authorization HTTP request header. Use ~ to indicate the current user. If you specify the user name, it must match the user name that is in the Authorization HTTP request header.

Query Parameters

• fields(optional): string

  You can use this parameter to request a subset of the MCS mobile user properties. This parameter doesn't apply to virtual or social users.

  Example:

  To retrieve only the properties firstName and lastName for an MCS mobile user, the call would pass the following query parameter:

  /mobile/platform/users/~?fields=firstName,lastName

  The call returns a response like this:

  {
    "firstName": "Joe",
    "lastName": "Doe"
  }
  

Back to Top

Response

Supported Media Types

• application/json

200 Response

The user information was retrieved successfully.

Body ()

Root Schema : Extended User Information

Type: object

Title: Extended User Information

Information about the current user.

Match One

Show Source

• object Mobile User Extended Information
  Title: Mobile User Extended Information

  Additional Properties Allowed: additionalProperties

  Information that is returned when the current user is an MCS mobile user.
• object Virtual User Extended Information
  Title: Virtual User Extended Information

  Information that is returned when the current user is a virtual user.
• object Social User Information
  Title: Social User Information

  Additional Properties Allowed: additionalProperties

  Information that is returned when the current user is a social user (that is, signed in using social identity).

{
    "title":"Extended User Information",
    "description":"Information about the current user.",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/mobileUserExtended"
        },
        {
            "$ref":"#/definitions/virtualUserExtended"
        },
        {
            "$ref":"#/definitions/socialUser"
        }
    ]
}

Nested Schema : Mobile User Extended Information

Type: object

Title: Mobile User Extended Information

Additional Properties Allowed

Show Source

• string

{
    "title":"Mobile User Extended Information",
    "description":"Information that is returned when the current user is an MCS mobile user.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "id":{
            "description":"The MCS unique identifier for the user.",
            "type":"string"
        },
        "lastName":{
            "description":"The last name of the user.",
            "type":"string"
        },
        "username":{
            "pattern":"[a-zA-Z0-9][a-zA-Z0-9\\-_\\.\\@]*",
            "description":"The user name for the user.",
            "type":"string"
        },
        "email":{
            "description":"The email address for the user.",
            "type":"string"
        },
        "roles":{
            "items":{
                "description":"The name of a single role.",
                "type":"string"
            },
            "description":"The roles associated with the mobile user.",
            "type":"array"
        },
        "links":{
            "description":"The relative resource path of this user.",
            "$ref":"#/definitions/linkObject"
        },
        "firstName":{
            "description":"The first name of the user.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "username",
        "links"
    ],
    "type":"object"
}

Information that is returned when the current user is an MCS mobile user.

Show Source

• email(optional): string
  The email address for the user.
• firstName(optional): string
  The first name of the user.
• id: string
  The MCS unique identifier for the user.
• lastName(optional): string
  The last name of the user.
• links: array Links that each reference a single object.
  Title: Links that each reference a single object.

  Minimum Number of Items: 1

  Unique Items Required: true
• roles(optional): array roles
  The roles associated with the mobile user.
• username: string
  Pattern: [a-zA-Z0-9][a-zA-Z0-9\-_\.\@]*

  The user name for the user.

{
    "title":"Mobile User Extended Information",
    "description":"Information that is returned when the current user is an MCS mobile user.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "id":{
            "description":"The MCS unique identifier for the user.",
            "type":"string"
        },
        "lastName":{
            "description":"The last name of the user.",
            "type":"string"
        },
        "username":{
            "pattern":"[a-zA-Z0-9][a-zA-Z0-9\\-_\\.\\@]*",
            "description":"The user name for the user.",
            "type":"string"
        },
        "email":{
            "description":"The email address for the user.",
            "type":"string"
        },
        "roles":{
            "items":{
                "description":"The name of a single role.",
                "type":"string"
            },
            "description":"The roles associated with the mobile user.",
            "type":"array"
        },
        "links":{
            "description":"The relative resource path of this user.",
            "$ref":"#/definitions/linkObject"
        },
        "firstName":{
            "description":"The first name of the user.",
            "type":"string"
        }
    },
    "required":[
        "id",
        "username",
        "links"
    ],
    "type":"object"
}

Nested Schema : Virtual User Extended Information

Type: object

Title: Virtual User Extended Information

Information that is returned when the current user is a virtual user.

Show Source

• roles(optional): array roles
  The roles associated with the virtual user.
• username: string
  Pattern: [a-zA-Z0-9][a-zA-Z0-9\-_\.\@]*

  The user name for the user.

{
    "title":"Virtual User Extended Information",
    "description":"Information that is returned when the current user is a virtual user.",
    "properties":{
        "username":{
            "pattern":"[a-zA-Z0-9][a-zA-Z0-9\\-_\\.\\@]*",
            "description":"The user name for the user.",
            "type":"string"
        },
        "roles":{
            "items":{
                "description":"The name of a single role.",
                "type":"string"
            },
            "description":"The roles associated with the virtual user.",
            "type":"array"
        }
    },
    "required":[
        "username"
    ],
    "type":"object"
}

Nested Schema : Social User Information

Type: object

Title: Social User Information

Additional Properties Allowed

Show Source

• string

{
    "title":"Social User Information",
    "description":"Information that is returned when the current user is a social user (that is, signed in using social identity).",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "username":{
            "description":"An MCS-generated unique ID for the social user for the specified provider.",
            "type":"string"
        },
        "mobileExtended":{
            "properties":{
                "identityProvider":{
                    "$ref":"#/definitions/identityProvider"
                }
            },
            "type":"object"
        }
    },
    "required":[
        "username",
        "mobileExtended"
    ],
    "type":"object"
}

Information that is returned when the current user is a social user (that is, signed in using social identity).

Show Source

• mobileExtended: object mobileExtended
• username: string
  An MCS-generated unique ID for the social user for the specified provider.

{
    "title":"Social User Information",
    "description":"Information that is returned when the current user is a social user (that is, signed in using social identity).",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "username":{
            "description":"An MCS-generated unique ID for the social user for the specified provider.",
            "type":"string"
        },
        "mobileExtended":{
            "properties":{
                "identityProvider":{
                    "$ref":"#/definitions/identityProvider"
                }
            },
            "type":"object"
        }
    },
    "required":[
        "username",
        "mobileExtended"
    ],
    "type":"object"
}

Nested Schema : Links that each reference a single object.

Type: array

Title: Links that each reference a single object.

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: object Paging Link
  Title: Paging Link

  A single link used for pagination.

{
    "title":"Links that each reference a single object.",
    "items":{
        "description":"A single link.",
        "$ref":"#/definitions/pagingLink"
    },
    "minItems":1,
    "uniqueItems":true,
    "type":"array"
}

Nested Schema : roles

Type: array

The roles associated with the mobile user.

Show Source

• Array of: string
  The name of a single role.

{
    "items":{
        "description":"The name of a single role.",
        "type":"string"
    },
    "description":"The roles associated with the mobile user.",
    "type":"array"
}

Nested Schema : Paging Link

Type: object

Title: Paging Link

A single link used for pagination.

Show Source

• href: string
• rel: string

{
    "title":"Paging Link",
    "description":"A single link used for pagination.",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "type":"object"
}

Nested Schema : roles

Type: array

The roles associated with the virtual user.

Show Source

• Array of: string
  The name of a single role.

{
    "items":{
        "description":"The name of a single role.",
        "type":"string"
    },
    "description":"The roles associated with the virtual user.",
    "type":"array"
}

Nested Schema : mobileExtended

Type: object

Show Source

• identityProvider(optional): object Identity Provider
  Title: Identity Provider

  Additional Properties Allowed: additionalProperties

  The provider through which the current social user signed in.

{
    "properties":{
        "identityProvider":{
            "$ref":"#/definitions/identityProvider"
        }
    },
    "type":"object"
}

Nested Schema : Identity Provider

Type: object

Title: Identity Provider

Additional Properties Allowed

Show Source

• string

{
    "title":"Identity Provider",
    "description":"The provider through which the current social user signed in.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "facebook":{
            "$ref":"#/definitions/facebook"
        }
    },
    "type":"object"
}

The provider through which the current social user signed in.

Show Source

• facebook(optional): object Facebook Social User Information
  Title: Facebook Social User Information

  Additional Properties Allowed: additionalProperties

  Facebook social user information.

{
    "title":"Identity Provider",
    "description":"The provider through which the current social user signed in.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "facebook":{
            "$ref":"#/definitions/facebook"
        }
    },
    "type":"object"
}

Nested Schema : Facebook Social User Information

Type: object

Title: Facebook Social User Information

Additional Properties Allowed

Show Source

• string

{
    "title":"Facebook Social User Information",
    "description":"Facebook social user information.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "accessToken":{
            "type":"string"
        }
    },
    "type":"object"
}

Facebook social user information.

Show Source

• accessToken(optional): string

{
    "title":"Facebook Social User Information",
    "description":"Facebook social user information.",
    "additionalProperties":{
        "type":"string"
    },
    "properties":{
        "accessToken":{
            "type":"string"
        }
    },
    "type":"object"
}

Example Response (application/json)

{
    "id":"295e450a-63f0-41fa-be43-cd2dbcb21598",
    "lastName":"Doe",
    "username":"joe",
    "email":"[e-mail]",
    "roles":[
        "Customer",
        "Trial"
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/extended/platform/users/joe"
        },
        {
            "rel":"self",
            "href":"/mobile/extended/platform/users/joe"
        }
    ],
    "firstName":"Joe"
}

400 Response

The operation can't be performed due to one of the following reasons:

• The Oracle-Mobile-Backend-ID HTTP request header was not specified.
• The query parameter fields was specified and one of the properties given isn't defined for the realm that the user belongs to.

Headers

• Content-Type: string

  The media type of the error message, which is application/json.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• 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
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. 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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service 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.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Example Response (application/json)

{
    "title":"Cannot call API",
    "detail":"Unable to use API virtualization for calls without any mobile backend context.",
    "status":400,
    "o:errorCode":"MOBILE-58060",
    "o:errorPath":"/mobile/platform/extended/users/joe",
    "o:ecid":"cde040005cd5983e:4372d958:14c8c4c2d6c:-8000-000000000032b9d5, 0",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}

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.

Headers

• Content-Type: string

  The media type of the error message, which is application/json.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• 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
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. 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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service 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.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Example Response (application/json)

{
    "title":"Unauthorized",
    "detail":"401 - Unauthorized",
    "status":401,
    "o:errorCode":"MOBILE-15209",
    "o:errorPath":"/mobile/platform/extended/users/joe",
    "o:ecid":"cde040005cd5983e:4372d958:14c8c4c2d6c:-8000-000000000033b51c, 0",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}

403 Response

The operation can't be performed due to one of the following reasons:

• The user doesn't belong to the realm that's associated with the mobile backend.
• The value of the Authorization HTTP request header that follows Basic or 'Bearer' 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.

Headers

• Content-Type: string

  The media type of the error message, which is application/json.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• 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
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. 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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service 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.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Example Response (application/json)

{
    "title":"Unsupported media type",
    "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.",
    "status":406,
    "o:errorCode":"MOBILE-92516",
    "o:errorPath":"/mobile/platform/extended/users/joe",
    "o:ecid":"cde040005cd5983e:4372d958:14c8c4c2d6c:-8000-000000000033ddba, 0",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}

Back to Top