DocumentationAPI reference

Rust · 0.1.0

Get Linked Identity

GET /api/v1/users/{user}/linkedIdentities/{linkedIdentity}

UserService · UserService_GetLinkedIdentity

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Requires the named account's owner or an instance administrator. Field-specific and lifecycle restrictions still apply; owner access does not allow changing administrator-only fields.

Request

GetLinkedIdentity gets a linked SSO identity for a user.

GET/api/v1/users/{user}/linkedIdentities/{linkedIdentity}

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.
linkedIdentity
path
string
Required
The linkedIdentity id.

Request body

No request body is declared.

Responses

200 · OK

application/json · LinkedIdentity

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "UserService"
  ],
  "description": "GetLinkedIdentity gets a linked SSO identity for a user.",
  "operationId": "UserService_GetLinkedIdentity",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "linkedIdentity",
      "in": "path",
      "description": "The linkedIdentity id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/LinkedIdentity"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}