Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Welcome to Struct PIM 4
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

Users

PreviousUserRolesNextVariantGroups

Returns a single user from the tenant

get
Authorizations
Path parameters
uidstringRequired
Responses
200
OK
404
Not Found
get
GET /v1/users/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "text",
  "Email": "text",
  "Firstname": "text",
  "Lastname": "text",
  "Status": 0,
  "UserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "Roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
delete
Authorizations
Path parameters
uidstringRequired
Responses
200
OK
404
Not Found
delete
DELETE /v1/users/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
  • GETGet all users in the tenant
  • POSTInvites a user to the tenant
  • PUT/v1/users
  • GETReturns a single user from the tenant
  • DELETE/v1/users/{uid}

Get all users in the tenant

get
Authorizations
Responses
200
OK
404
Not Found
get
GET /v1/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "text",
  "Email": "text",
  "Firstname": "text",
  "Lastname": "text",
  "Status": 0,
  "UserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "Roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Invites a user to the tenant

post
Authorizations
Body

Model for inviting a user to a tenant

UserEmailstring | nullableOptional

Email of the user to invite

TenantRoleUidsstring · uuid[] | nullableOptional

Roles to assign to the user

TenantUserGroupUidsstring · uuid[] | nullableOptional

User groups to assign to the user

InvitedBystring | nullableOptional

Who invited the user

Messagestring | nullableOptional

Message to include in the invitation

Responses
200
OK
404
Not Found
post
POST /v1/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 177

{
  "UserEmail": "text",
  "TenantRoleUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "TenantUserGroupUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "InvitedBy": "text",
  "Message": "text"
}
No content
put
Authorizations
Body

Represents a model for updating a user

UserUidstring | nullableOptional

The unique identifier of the user

Rolesstring · uuid[] | nullableOptional

The roles to assign to the user

UserGroupsstring · uuid[] | nullableOptional

The user groups to assign to the user

Responses
200
OK
404
Not Found
put
PUT /v1/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 121

{
  "UserUid": "text",
  "Roles": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "UserGroups": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
No content