Retrieve a membership

Retrieves a membership with a specified organization ID and user ID.

SecuritySecretApiKey or JWT
Request
path Parameters
organizationId
required
string (ResourceId) <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
userId
required
string (ResourceId) <= 50 characters

ID of the user.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Membership retrieved.

Response Schema: application/json
required
object

Organization membership.

id
string <= 50 characters

ID of the organization.

name
string

Name of the organization.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

required
object

Membership user.

id
string <= 50 characters

Organization ID.

name
string

First and last name of the user.

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

permissions
Array of strings <operationId>

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

isOwner
boolean

Specifies whether the user is the owner of the organization.

isDefault
boolean

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

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

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/memberships/{organizationId}/{userId}
Request samples
Response samples
application/json
{
  • "organization": {
    },
  • "user": {
    },
  • "allowedIps": [
    ],
  • "permissions": [
    ],
  • "isOwner": true,
  • "isDefault": true,
  • "roleIds": [
    ],
  • "_links": [
    ]
}