GET
/api/organizations/{organization_id}/members/{uid}/roleAuthenticatedGet a member's role
Returns the role one user holds in the organization. Members of the organization and platform administrators may call it.
operationId
get_api_organizations_organization_id_members_uid_roleOrganizationsAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
- Notes
- The caller must be a member of the organization or a platform administrator.
Path parameters
| Name | Type | Description |
|---|---|---|
| organization_id* | string | Organization id (URL-safe slug) |
| uid* | string (uuid) | User id of the member |
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| data* | object | |
| role* | string | Membership role in the organization: |
JSONExample
"success"true
"message""string"
"data"
"role""member"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/organizations/<organization_id>/members/<uid>/role' \
-b 'refresh_token_<auth_server_app_id>=<value>'