Retrieve Extended User Information

get

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

Deprecated. Use Retrieve My Profile (GET /mobile/platform/users/me) instead.

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

• When the user is a mobile user, this operation retrieves the user name, first name, last name, roles, and email address.
• 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 ID, and identity provider.

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

To perform this operation, you must be a mobile user that has a role that's associated with the mobile backend or you must be a virtual or social user.

Request

Path Parameters

• username: string

  The user name of the current 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's in the Authorization HTTP request header.

Query Parameters

• fields(optional): string

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

  Example:

  To retrieve only the properties firstName and lastName for a 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"
  }
  

Response

Supported Media Types

• application/json

200 Response

The user information was retrieved successfully.

Body ()

Information about the current user.

Root Schema : userExtended

Type: object

Information about the current user.

Match One

Show Source

• object mobileUserExtended
  Information that's returned when the current user is a mobile user.
• object virtualUserExtended
  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).

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

Nested Schema : mobileUserExtended

Type: object

Information that's returned when the current user is a mobile user.

Show Source

• email: string
  The email address for the user.
• firstName: string
  The first name of the user.
• id: string
  The unique identifier for the user.
• lastName: 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: array roles
  The roles associated with the user.
• username: string
  Pattern: [a-zA-Z0-9][a-zA-Z0-9\-_\.\@]*

  The user name for the user.

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

Nested Schema : virtualUserExtended

Type: object

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

Show Source

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

  The user name for the user.

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

Nested Schema : Social User Information

Type: object

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).

Show Source

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

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

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

• [0]: object pagingLink
  A single link used for pagination.

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

Nested Schema : roles

Type: array

The roles associated with the user.

Show Source

• [0]: string
  The name of a single role.

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

Nested Schema : pagingLink

Type: object

A single link used for pagination.

Show Source

• href: string
• rel: string

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

Nested Schema : roles

Type: array

The roles associated with the user.

Show Source

• [0]: string
  The name of a single role.

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

Nested Schema : mobileExtended

Type: object

Show Source

• identityProvider: object Identity Provider
  Title: Identity Provider

  Additional Properties Allowed: true

  The provider through which the current social user signed in.

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

Nested Schema : Identity Provider

Type: object

Title: Identity Provider

Additional Properties Allowed: true

The provider through which the current social user signed in.

Show Source

• facebook: object Facebook Information
  Title: Facebook Information

  Additional Properties Allowed: true

  Facebook social user information.

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

Nested Schema : Facebook Information

Type: object

Title: Facebook Information

Additional Properties Allowed: true

Facebook social user information.

Show Source

• accessToken: string

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

Example Response (application/json)

{
    "firstName":"Joe",
    "lastName":"Doe",
    "roles":[
        "Customer",
        "Trial"
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/extended/platform/users/joe"
        },
        {
            "rel":"self",
            "href":"/mobile/extended/platform/users/joe"
        }
    ],
    "id":"295e450a-63f0-41fa-be43-cd2dbcb21598",
    "email":"[e-mail]",
    "username":"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 doesn't exist.

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 the 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
  The service's error code.
• o:errorDetails: 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.

{
    "description":"The error JSON object returned by the service.",
    "title":"Error",
    "type":"object",
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "minItems":0,
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/errorDetail"
            }
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "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: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"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    }
}

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

• [0]: object Error Detail
  Title: Error Detail

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

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
  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.

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

Example Response (application/json)

{
    "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/extended/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.

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 the 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
  The service's error code.
• o:errorDetails: 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.

{
    "description":"The error JSON object returned by the service.",
    "title":"Error",
    "type":"object",
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "minItems":0,
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/errorDetail"
            }
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "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: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"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    }
}

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

• [0]: object Error Detail
  Title: Error Detail

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

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
  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.

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

Example Response (application/json)

{
    "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/extended/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 the role 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 the 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
  The service's error code.
• o:errorDetails: 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.

{
    "description":"The error JSON object returned by the service.",
    "title":"Error",
    "type":"object",
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "minItems":0,
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/errorDetail"
            }
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "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: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"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    }
}

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

• [0]: object Error Detail
  Title: Error Detail

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

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
  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.

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

Example Response (application/json)

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