Memberships

Use these operations to manage user membership within your organizations. Membership describes the relationship between organizations and users. For example, one user could be a member of more than one organization.

Operations

Retrieve memberships

Request

Retrieves a list of organization memberships.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/memberships?limit=0&offset=0&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of organization memberships retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
organizationobjectread-onlyrequired

Organization membership.

userobjectread-onlyrequired

Membership user.

allowedIpsArray of strings or null, (ip)(AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Example:
[
  "153.12.32.33",
  "201.54.122.0/24",
  "2001:0db8:abcd:0012:0000:0000:0000:ffff",
  "2001:db8:abcd:12::0/64"
]
permissionsArray of strings, (operationId)(AclPermissions)

Permissions that the user has within the organization. Use the wildcard character * for full access.

Example:
[
  "PostFile",
  "StorefrontGetAccount",
  "StorefrontGetWebsite",
  "StorefrontGetKycDocument",
  "StorefrontPostKycDocument"
]
isOwnerboolean

Specifies if the user is the owner of the organization.

isDefaultbooleanread-only

Specifies if the organization is the default organization for the user.

roleIdsArray of strings

Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.

aclArray of objects(Acl)read-only

Access Control List (ACL) information.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "organization": { … },
    "user": { … },
    "allowedIps": [ … ],
    "permissions": [ … ],
    "isOwner": true,
    "isDefault": true,
    "roleIds": [ … ],
    "acl": [ … ],
    "_links": [ … ],
    "_embedded": { … }
  }
]