Directory API: Memberships

Retrieves one specific membership

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

membershipstring · uuidRequired

Responses

200

OK

application/jsontext/json

groupIdstring · uuidOptional

membershipIdstring · uuidOptional

modifiedBystring · uuidOptional

organizationIdstring · uuidOptional

userIdstring · uuidOptional

membershipFunctionstring · nullableOptional

membershipEffectivestring · date-timeOptional

membershipExpirystring · date-time · nullableOptional

modifiedstring · date-timeOptional

get

/api/directory/memberships/{membership}

HTTPcURLJavaScriptPython

GET /v2/e01/api/directory/memberships/{membership} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "membershipId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "membershipFunction": "text",
  "membershipEffective": "2026-03-13T14:18:49.162Z",
  "membershipExpiry": "2026-03-13T14:18:49.162Z",
  "modified": "2026-03-13T14:18:49.162Z"
}

Checks for the existence of one specific membership

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

membershipstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/directory/memberships/{membership}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/directory/memberships/{membership} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

modifiedBystring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

accountScopestring · nullableOptional

membershipFunctionstring · nullableOptional

membershipEffectivestring · date-time · nullableOptional

membershipExpirystring · date-time · nullableOptional

modifiedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

groupIdstring · uuidOptional

membershipIdstring · uuidOptional

modifiedBystring · uuidOptional

organizationIdstring · uuidOptional

userIdstring · uuidOptional

membershipFunctionstring · nullableOptional

membershipEffectivestring · date-timeOptional

membershipExpirystring · date-time · nullableOptional

modifiedstring · date-timeOptional

post

/api/directory/memberships/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/memberships/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 828

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:18:49.162Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "accountScope": "text",
  "membershipFunction": "text",
  "membershipEffective": "2026-03-13T14:18:49.162Z",
  "membershipExpiry": "2026-03-13T14:18:49.162Z",
  "modified": "2026-03-13T14:18:49.162Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "membershipId": "123e4567-e89b-12d3-a456-426614174000",
    "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "membershipFunction": "text",
    "membershipEffective": "2026-03-13T14:18:49.162Z",
    "membershipExpiry": "2026-03-13T14:18:49.162Z",
    "modified": "2026-03-13T14:18:49.162Z"
  }
]

Counts the memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

modifiedBystring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

accountScopestring · nullableOptional

membershipFunctionstring · nullableOptional

membershipEffectivestring · date-time · nullableOptional

membershipExpirystring · date-time · nullableOptional

modifiedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/directory/memberships/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/memberships/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 828

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:18:49.162Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "accountScope": "text",
  "membershipFunction": "text",
  "membershipEffective": "2026-03-13T14:18:49.162Z",
  "membershipExpiry": "2026-03-13T14:18:49.162Z",
  "modified": "2026-03-13T14:18:49.162Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

modifiedBystring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

accountScopestring · nullableOptional

membershipFunctionstring · nullableOptional

membershipEffectivestring · date-time · nullableOptional

membershipExpirystring · date-time · nullableOptional

modifiedstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/directory/memberships/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/memberships/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 828

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:18:49.162Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "accountScope": "text",
  "membershipFunction": "text",
  "membershipEffective": "2026-03-13T14:18:49.162Z",
  "membershipExpiry": "2026-03-13T14:18:49.162Z",
  "modified": "2026-03-13T14:18:49.162Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of memberships that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

modifiedBystring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

accountScopestring · nullableOptional

membershipFunctionstring · nullableOptional

membershipEffectivestring · date-time · nullableOptional

membershipExpirystring · date-time · nullableOptional

modifiedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

membershipIdstring · uuidOptional

post

/api/directory/memberships/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/memberships/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 828

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:18:49.162Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "accountScope": "text",
  "membershipFunction": "text",
  "membershipEffective": "2026-03-13T14:18:49.162Z",
  "membershipExpiry": "2026-03-13T14:18:49.162Z",
  "modified": "2026-03-13T14:18:49.162Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "membershipId": "123e4567-e89b-12d3-a456-426614174000"
  }
]