Access Relationship API
List Access Relationships
List access relationships for a subject (app instance, resource, role, or team).
get/v2/access-relationships
Request
- Base URLhttps://public.api.serval.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
subjectType'ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED' | 'ACCESS_RELATIONSHIP_SUBJECT_TYPE_APP_INSTANCE' | 'ACCESS_RELATIONSHIP_SUBJECT_TYPE_RESOURCE' | 'ACCESS_RELATIONSHIP_SUBJECT_TYPE_ENTITLEMENT' | 'ACCESS_RELATIONSHIP_SUBJECT_TYPE_TEAM' required
The kind of entity a relationship is on. Generalizes the former app_relationships model (app_instance subjects only) so resources, roles (entitlements), and teams can have owners too.
The kind of subject to list relationships for.
subjectIdstring required
The ID of the subject (app_instance_id | resource_id | entitlement_id | team_id), disambiguated by subject_type.
targetIdstring
Filter by target ID (user or group ID).
targetType'ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED' | 'ACCESS_RELATIONSHIP_TARGET_TYPE_USER' | 'ACCESS_RELATIONSHIP_TARGET_TYPE_GROUP'
Filter by target type.
relationshipType'ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED' | 'ACCESS_RELATIONSHIP_TYPE_OWNER'
Filter by relationship type.
pageSizeinteger
Maximum number of results to return per page.
pageTokenstring
Token for retrieving the next page of results.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.