ServiceAccount [v1]

Description

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

Type

object

Specification

PropertyTypeDescription

apiVersion

string

APIVersion 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

automountServiceAccountToken

boolean

AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.

imagePullSecrets

array

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

object

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

kind

string

Kind 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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

secrets

array

Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a “kubernetes.io/enforce-mountable-secrets” annotation set to “true”. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret

secrets[]

object

ObjectReference contains enough information to let you inspect or modify the referred object.

.imagePullSecrets

Description

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod

Type

array

.imagePullSecrets[]

Description

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Type

object

PropertyTypeDescription

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.secrets

Description

Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a “kubernetes.io/enforce-mountable-secrets” annotation set to “true”. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret

Type

array

.secrets[]

Description

ObjectReference contains enough information to let you inspect or modify the referred object.

Type

object

PropertyTypeDescription

apiVersion

string

API version of the referent.

fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kind

string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

API endpoints

The following API endpoints are available:

  • /api/v1/serviceaccounts

    • GET: list or watch objects of kind ServiceAccount
  • /api/v1/watch/serviceaccounts

    • GET: watch individual changes to a list of ServiceAccount. deprecated: use the ‘watch’ parameter with a list operation instead.
  • /api/v1/namespaces/{namespace}/serviceaccounts

    • DELETE: delete collection of ServiceAccount

    • GET: list or watch objects of kind ServiceAccount

    • POST: create a ServiceAccount

  • /api/v1/watch/namespaces/{namespace}/serviceaccounts

    • GET: watch individual changes to a list of ServiceAccount. deprecated: use the ‘watch’ parameter with a list operation instead.
  • /api/v1/namespaces/{namespace}/serviceaccounts/{name}

    • DELETE: delete a ServiceAccount

    • GET: read the specified ServiceAccount

    • PATCH: partially update the specified ServiceAccount

    • PUT: replace the specified ServiceAccount

  • /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

    • GET: watch changes to an object of kind ServiceAccount. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

/api/v1/serviceaccounts

HTTP method

GET

Description

list or watch objects of kind ServiceAccount

Table 1. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccountList schema

401 - Unauthorized

Empty

/api/v1/watch/serviceaccounts

HTTP method

GET

Description

watch individual changes to a list of ServiceAccount. deprecated: use the ‘watch’ parameter with a list operation instead.

Table 2. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/api/v1/namespaces/{namespace}/serviceaccounts

HTTP method

DELETE

Description

delete collection of ServiceAccount

Table 3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 4. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind ServiceAccount

Table 5. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccountList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a ServiceAccount

Table 6. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 7. Body parameters
ParameterTypeDescription

body

ServiceAccount schema

Table 8. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccount schema

201 - Created

ServiceAccount schema

202 - Accepted

ServiceAccount schema

401 - Unauthorized

Empty

/api/v1/watch/namespaces/{namespace}/serviceaccounts

HTTP method

GET

Description

watch individual changes to a list of ServiceAccount. deprecated: use the ‘watch’ parameter with a list operation instead.

Table 9. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/api/v1/namespaces/{namespace}/serviceaccounts/{name}

Table 10. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceAccount

HTTP method

DELETE

Description

delete a ServiceAccount

Table 11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 12. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccount schema

202 - Accepted

ServiceAccount schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified ServiceAccount

Table 13. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccount schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified ServiceAccount

Table 14. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccount schema

201 - Created

ServiceAccount schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified ServiceAccount

Table 16. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 17. Body parameters
ParameterTypeDescription

body

ServiceAccount schema

Table 18. HTTP responses
HTTP codeReponse body

200 - OK

ServiceAccount schema

201 - Created

ServiceAccount schema

401 - Unauthorized

Empty

/api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

Table 19. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceAccount

HTTP method

GET

Description

watch changes to an object of kind ServiceAccount. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Table 20. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty