Zum Hauptinhalt springen

Get profile information for the specified user if the user is related to the executing user

GET/v2/user/{userId}
API-Version
v2
Request-Methode
GET
Operation-ID
deprecated-user-service-user-get

Use /v2/users/{userId} instead.

Request​

  • userIdstringrequired

Responses​

Format
application/json
Beschreibung

The Profile

  • avatarRefstring (uuid)
  • customerMembershipsobject
    • *object
      • expiresAtstring (date-time)
      • idstring (uuid)required
      • memberSincestring (date-time)required
      • rolestring (einer von: owner, member, accountant)required
  • emailstring (email)
  • employeeInformationobject

    Additional information about mittwald employees.

    • departmentstringrequired
  • isEmployeeboolean

    Truth value, whether the user is a mittwald employee

  • mfaobject
    • activebooleanrequired
    • setupbooleanrequired
  • passwordUpdatedAtstring (date-time)
  • personobjectrequired

    The users personal information, e.g. first name.

    • firstNamestringrequired

      The users first name

    • lastNamestringrequired

      The users last name

    • titlestring (einer von: mr, ms, other)
  • phoneNumberstring
  • projectMembershipsobject
    • *object
      • expiresAtstring (date-time)
      • idstring (uuid)
      • inheritedbooleanrequired
      • memberSincestring (date-time)required
      • rolestring (einer von: owner, emailadmin, external, id)required
  • registeredAtstring (date-time)
  • userIdstring (uuid)required
Content-Type: application/json

{
  "avatarRef": "f0f86186-0a5a-45b2-aa33-502777496347",
  "customerMemberships": {
    "string": {
      "expiresAt": "1985-10-26T01:21:00.000Z",
      "id": "f0f86186-0a5a-45b2-aa33-502777496347",
      "memberSince": "1985-10-26T01:21:00.000Z",
      "role": "owner"
    }
  },
  "email": "email@mittwald.example",
  "employeeInformation": {
    "department": "Kundenservice"
  },
  "isEmployee": true,
  "mfa": {
    "active": true,
    "setup": true
  },
  "passwordUpdatedAt": "1985-10-26T01:21:00.000Z",
  "person": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "title": "mr"
  },
  "phoneNumber": "+491701234567",
  "projectMemberships": {
    "string": {
      "expiresAt": "1985-10-26T01:21:00.000Z",
      "id": "f0f86186-0a5a-45b2-aa33-502777496347",
      "inherited": true,
      "memberSince": "1985-10-26T01:21:00.000Z",
      "role": "owner"
    }
  },
  "registeredAt": "1985-10-26T01:21:00.000Z",
  "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
}
{
  "properties": {
    "avatarRef": {
      "format": "uuid",
      "type": "string"
    },
    "customerMemberships": {
      "additionalProperties": {
        "properties": {
          "expiresAt": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "memberSince": {
            "format": "date-time",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "member",
              "accountant"
            ],
            "type": "string"
          }
        },
        "required": [
          "role",
          "memberSince",
          "id"
        ],
        "type": "object"
      },
      "type": "object"
    },
    "email": {
      "format": "email",
      "type": "string"
    },
    "employeeInformation": {
      "description": "Additional information about mittwald employees.",
      "properties": {
        "department": {
          "example": "Kundenservice",
          "type": "string"
        }
      },
      "required": [
        "department"
      ],
      "type": "object"
    },
    "isEmployee": {
      "description": "Truth value, whether the user is a mittwald employee",
      "type": "boolean"
    },
    "mfa": {
      "properties": {
        "active": {
          "default": false,
          "type": "boolean"
        },
        "setup": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "active",
        "setup"
      ],
      "type": "object"
    },
    "passwordUpdatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "person": {
      "type": "object",
      "description": "The users personal information, e.g. first name.",
      "properties": {
        "firstName": {
          "type": "string",
          "description": "The users first name",
          "example": "Ada"
        },
        "lastName": {
          "type": "string",
          "description": "The users last name",
          "example": "Lovelace"
        },
        "title": {
          "type": "string",
          "enum": [
            "mr",
            "ms",
            "other"
          ]
        }
      },
      "required": [
        "lastName",
        "firstName"
      ]
    },
    "phoneNumber": {
      "example": "+491701234567",
      "type": "string"
    },
    "projectMemberships": {
      "additionalProperties": {
        "properties": {
          "expiresAt": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "inherited": {
            "type": "boolean"
          },
          "memberSince": {
            "format": "date-time",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "emailadmin",
              "external",
              "id"
            ],
            "type": "string"
          }
        },
        "required": [
          "role",
          "memberSince",
          "inherited"
        ],
        "type": "object"
      },
      "type": "object"
    },
    "registeredAt": {
      "format": "date-time",
      "type": "string"
    },
    "userId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "userId",
    "person"
  ],
  "type": "object"
}

Nutzungsbeispiele​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/user/string
import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.deprecatedUserServiceUserGet({
  "userId": "string"
});

assertStatus(response, 200);
  
use \Mittwald\ApiClient\Generated\V2\Clients\User\DeprecatedUserServiceUserGet\DeprecatedUserServiceUserGetRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new DeprecatedUserServiceUserGetRequest(
  userId: "string"
));
$response = $client->user()->deprecatedUserServiceUserGet($request);

var_dump($response->getBody();

Auf dieser Seite