UserRoleTuple

UserRoleTuple Type

Audience: Programmer

Deprecated: This type is deprecated. Use UserTenants instead for better multi-tenant support.

Represents a role assignment for a user within a specific tenant. This type pairs a role with its tenant context, enabling users to have different roles in different tenants.

Fields

Field
Type
Description

Role

String!

The role assigned to the user

TenantID

UUID!

The tenant identifier where this role applies

Deprecation Notice

UserRoleTuple is deprecated in favor of the more comprehensive UserTenants type, which includes:

  • Tenant name for better usability

  • Clearer structure for multi-tenant scenarios

  • Consistent naming with other pyck types

Migration Example

Old Usage (Deprecated)

query {
  me {
    AssignedRoles {
      Role
      TenantID
    }
  }
}

Differences from UserTenants

UserRoleTuple
UserTenants
Improvement

TenantID field

ID field

Consistent naming

No tenant name

Name field

Better user experience

Role-centric

Tenant-centric

Clearer multi-tenant model

Legacy Support

This type remains available for backward compatibility but should not be used in new implementations. The UserProfile.AssignedRoles field that returns this type is also deprecated.

See Also

  • UserTenants - The recommended replacement type

  • UserProfile - Contains both legacy and modern tenant associations

Last updated

Was this helpful?