REST API for Oracle Commerce Cloud 21B

Get a user

get

/swm/rs/v1/sites/{siteId}/users/{userId}

Get a specific user profile information.

A user can only access himself/herself, thus the specified userId has to be the same as that of the API user.

Request

Supported Media Types

application/json

Path Parameters

siteId: string

The ID of the site resource
userId: string

The ID of the user resource

Response

Supported Media Types

application/json; charset=UTF-8

200 Response

user resource found

403 Response

user resource action forbidden

404 Response

user resource not found

Examples

Sample Request:

       GET swm/rs/v1/sites/RoGcM7ZB1dwMgzI6/users/nNGCePPATZMzzpCm

Sample Response:

       {"response":{"code":"200.0","developerMessage":"user resource found" },
        "notifyNewMemberFlag":"0",
        "firstName":"John",
        "lastName":"Doe",
        "notifyCommentFlag":"o",
        "mediaUrl":"/preview/media/user/AMA1iqn08Jz8QGqG/Nofqo28WCmGVLiGn72UssMwE.png",
        "ccOrganizationName":"",
        "ccOrganizationLogoURL":"",
        "emailAddress":"john.doe@example.com",
        "userId":"nNGCePPATZMzzpCm"
       }

Possible Error Codes:

       {
          "code":"404.0","developerMessage":"user resource not found"
       }