Skip to main content

TeleportScopedRoleAssignmentV1

Report an Issue

This guide lists the fields in the TeleportScopedRoleAssignmentV1 resource, which you can apply after installing the Teleport Kubernetes operator.

resources.teleport.dev/v1​

apiVersion: resources.teleport.dev/v1

FieldTypeDescription
apiVersionstringAPIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kindstringKind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadataobject
scopestringScope is the scope of the role assignment resource.
specobjectScopedRoleAssignment resource definition v1 from Teleport

spec​

FieldTypeDescription
assignments[]objectAssignments is a list of individual role @ scope assignments
botstringThe Bot to whom all contained assignments apply, as a scope-qualified name of the form <scope>::<bot-name> (e.g. "/staging/west::mybot"). Mutually exclusive with user. When specified, assignment scopes must be equal or descendent of the scope indicated by this field.
traits[]objectA list of individual traits @ scope assignments
userstringUser is the user to whom all contained assignments apply. Mutually exclusive with bot.

spec.assignments items​

FieldTypeDescription
rolestringRole is the scope-qualified name of the role that is assigned by this assignment.
scopestringScope is the scope to which the role is assigned. This must be a member/child of the scope of the [ScopedRoleAssignment] in which this assignment is contained.

spec.traits items​

FieldTypeDescription
scopestringThe scope to which the traits are assigned. This must be a member/child of the scope of the [ScopedRoleAssignment] in which this assignment is contained.
traitsobjectA list of traits that should be applied at this scope.

spec.traits items.traits​

FieldTypeDescription
keystring
value[]string