Jump to

• Request
• Response
• Examples

List of users

get

/appstore/publisher/v1/users

Fetch all the users registered with current company (partner).

Request

Query Parameters

• limit(optional): integer(int32)
  Limit tells how many records to return (starting from the offset). Limit should be greater than zero and less than or equal to 100 (default=30).
• name(optional): string
  This is a filter option used to get the result set with given name. Multiple values for this parameter is also supported. Please use comma-separated values when searching for users corresponding to multiple names.
• offset(optional): integer(int32)
  Offset and limit together determine how many records to return from the collection. Offset is the starting index of the records to return, which should be greater than or equal to zero (default=0).
• orderby(optional): string
  This property sorts the result set. Acceptable values are FIRSTNAME, LASTNAME, LASTMODIFICATIONDATE, ROLEID.
• sortorder(optional): string
  This property specifies the order in which to sort the result set. Acceptable values are ASC and DESC.

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : collection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• links(optional): array link
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"collection"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object User

{
    "type":"array",
    "xml":{
        "name":"items",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : User

Type: object

Show Source

• createdBy(optional): string
• creationDate(optional): string
• email(optional): string
• firstName(optional): string
• lastModificationDate(optional): string
• lastModifiedBy(optional): string
• lastName(optional): string
• role(optional): object Role
• userId(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"integer",
            "format":"int64"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "role":{
            "$ref":"#/definitions/Role"
        },
        "createdBy":{
            "type":"string"
        },
        "creationDate":{
            "type":"string"
        },
        "lastModifiedBy":{
            "type":"string"
        },
        "lastModificationDate":{
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

Show Source

• roleId(optional): integer(int64)
• roleName(optional): string

{
    "type":"object",
    "properties":{
        "roleId":{
            "type":"integer",
            "format":"int64"
        },
        "roleName":{
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• rel(optional): string
  Allowed Values: [ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "SELF",
                "CANONICAL",
                "NEXT",
                "TEMPLATE",
                "PREV"
            ]
        },
        "href":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example returns a list of all the users associated with a partner, by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users"

Request Header

X-Oracle-UserId: [e-mail]
Authorization: Bearer Access-token

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
      "users": {
        "userId": 13021992,
        "firstName": "John",
        "lastName": "David",
        "email": "[e-mail]",
        "role": {
          "roleId": 1,
          "roleName": "Partner Administrator"
        },
        "createdBy": "John David",
        "creationDate": "2018-02-09T21:32:02.000Z",
        "lastModifiedBy": "John David",
        "lastModificationDate": "2018-02-09T21:32:02.000Z"
      }
    },
    {
      "users": {
        "userId": 9483277,
        "firstName": "Sachin",
        "lastName": "Patel",
        "email": "[e-mail]",
        "role": {
          "roleId": 2,
          "roleName": "Partner Member"
        },
        "createdBy": "John David",
        "creationDate": "2018-02-09T21:32:02.000Z",
        "lastModifiedBy": "John David",
        "lastModificationDate": "2018-02-09T21:32:02.000Z"
      }
    }
  ],
  "hasMore": false,
  "count": 2,
  "totalResults": 2,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users"
    }
  ]
}

Back to Top