사용자 및 그룹 API
사용자 및 그룹 API에 대한 참조 가이드
초록
1장. 사용자 및 그룹 API
1.1. Group [user.openshift.io/v1]
- 설명
group은 참조 가능한 사용자 세트를 나타냅니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.2. Identity [user.openshift.io/v1]
- 설명
ID는 ID 공급자가 있는 사용자의 성공적인 인증을 기록합니다. 인증 소스에 대한 정보는 ID에 저장되고 ID는 단일 사용자 오브젝트와 연결됩니다. 여러 ID는 단일 사용자를 참조할 수 있습니다. 인증 공급자에서 검색된 정보는 공급자가 결정한 스키마를 사용하여 추가 필드에 저장됩니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.3. UserIdentityMapping [user.openshift.io/v1]
- 설명
useridentitymapping은 사용자를 ID에 매핑
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.4. User [user.openshift.io/v1]
- 설명
로그인하면 시스템의 모든 사용자가 User 및 Identity 리소스를 수신합니다. 관리자는 사용자의 속성을 자체 추적에 대해 직접 조작하거나 API를 통해 그룹을 설정할 수 있습니다. 사용자 이름은 고유하며 ID 공급자가 제공하는 값에 따라 선택합니다. - 사용자가 들어오는 이름이 이미 있는 경우 사용자 이름에 시스템 구성에 따라 추가된 숫자가 있을 수 있습니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
2장. Group [user.openshift.io/v1]
- 설명
group은 참조 가능한 사용자 세트를 나타냅니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
사용자
-
2.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 메타데이터는 표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| 사용자는 이 그룹의 사용자 목록입니다. |
2.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/groups
-
DELETE
: 그룹 컬렉션 삭제 -
GET
: 그룹 유형의 오브젝트 목록 또는 감시 -
POST
: 그룹 생성
-
/apis/user.openshift.io/v1/watch/groups
-
GET
: 더 이상 사용되지 않는 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
/apis/user.openshift.io/v1/groups/{name}
-
DELETE
: 그룹 삭제 -
GET
: 지정된 그룹 읽기 -
PATCH
: 지정된 그룹을 부분적으로 업데이트 -
PUT
: 지정된 그룹 교체
-
/apis/user.openshift.io/v1/watch/groups/{name}
-
GET
: 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
2.2.1. /apis/user.openshift.io/v1/groups
- HTTP 방법
-
DELETE
- 설명
- 그룹 컬렉션 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 그룹 유형의 오브젝트 나열 또는 감시
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- 그룹 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
2.2.2. /apis/user.openshift.io/v1/watch/groups
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 그룹에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
2.2.3. /apis/user.openshift.io/v1/groups/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 그룹 이름 |
- HTTP 방법
-
DELETE
- 설명
- 그룹 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 그룹 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 그룹을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 그룹 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
2.2.4. /apis/user.openshift.io/v1/watch/groups/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 그룹 이름 |
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
3장. Identity [user.openshift.io/v1]
- 설명
ID는 ID 공급자가 있는 사용자의 성공적인 인증을 기록합니다. 인증 소스에 대한 정보는 ID에 저장되고 ID는 단일 사용자 오브젝트와 연결됩니다. 여러 ID는 단일 사용자를 참조할 수 있습니다. 인증 공급자에서 검색된 정보는 공급자가 결정한 스키마를 사용하여 추가 필드에 저장됩니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
providerName
-
providerUserName
-
user
-
3.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 이 ID에 대한 추가 정보가 있습니다. |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 메타데이터는 표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| ProviderName은 ID 정보의 소스입니다. |
|
| ProviderUserName은 공급자 범위에서 이 ID를 고유하게 나타냅니다. |
| 사용자는 이 ID가 둘 다 이름과 UID와 연결되어 있는 사용자에 대한 참조입니다. |
3.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/identities
-
DELETE
: Identity의 컬렉션 삭제 -
GET
: ID 유형의 오브젝트 목록 또는 감시 -
POST
: Identity 생성
-
/apis/user.openshift.io/v1/watch/identities
-
GET
: individual changes to a list of Identity. deprecated: 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
/apis/user.openshift.io/v1/identities/{name}
-
DELETE
: Identity 삭제 -
GET
: 지정된 ID 읽기 -
PATCH
: 지정된 ID를 부분적으로 업데이트 -
PUT
: 지정된 ID를 교체
-
/apis/user.openshift.io/v1/watch/identities/{name}
-
GET
: 더 이상 사용되지 않는 개체의 변경 사항을 조사합니다. 대신 목록 작업과 함께 'watch' 매개 변수를 사용하여 'fieldSelector' 매개 변수를 사용하여 단일 항목으로 필터링합니다.
-
3.2.1. /apis/user.openshift.io/v1/identities
- HTTP 방법
-
DELETE
- 설명
- ID 컬렉션 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ID 유형의 오브젝트 나열 또는 감시
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ID 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
3.2.2. /apis/user.openshift.io/v1/watch/identities
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 ID 목록에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
3.2.3. /apis/user.openshift.io/v1/identities/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ID의 이름 |
- HTTP 방법
-
DELETE
- 설명
- ID 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ID 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ID를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ID 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
3.2.4. /apis/user.openshift.io/v1/watch/identities/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ID의 이름 |
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 오브젝트의 변경 사항을 확인합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
4장. UserIdentityMapping [user.openshift.io/v1]
- 설명
useridentitymapping은 사용자를 ID에 매핑
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
4.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| ID는 ID에 대한 참조입니다. | |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 메타데이터는 표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
| 사용자는 사용자에 대한 참조입니다. |
4.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/useridentitymappings
-
POST
: UserIdentityMapping 생성
-
/apis/user.openshift.io/v1/useridentitymappings/{name}
-
DELETE
: UserIdentityMapping 삭제 -
GET
: 지정된 UserIdentityMapping 읽기 -
PATCH
: 지정된 UserIdentityMapping을 부분적으로 업데이트 -
PUT
: 지정된 UserIdentityMapping을 교체합니다.
-
4.2.1. /apis/user.openshift.io/v1/useridentitymappings
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
- HTTP 방법
-
POST
- 설명
- UserIdentityMapping 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
202 - 승인됨 | |
401 - 무단 | 빈 |
4.2.2. /apis/user.openshift.io/v1/useridentitymappings/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| UserIdentityMapping의 이름 |
- HTTP 방법
-
DELETE
- 설명
- UserIdentityMapping 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 UserIdentityMapping 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 UserIdentityMapping을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 UserIdentityMapping을 바꿉니다.
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
5장. User [user.openshift.io/v1]
- 설명
로그인하면 시스템의 모든 사용자가 User 및 Identity 리소스를 수신합니다. 관리자는 사용자의 속성을 자체 추적에 대해 직접 조작하거나 API를 통해 그룹을 설정할 수 있습니다. 사용자 이름은 고유하며 ID 공급자가 제공하는 값에 따라 선택합니다. - 사용자가 들어오는 이름이 이미 있는 경우 사용자 이름에 시스템 구성에 따라 추가된 숫자가 있을 수 있습니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
groups
-
5.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Fullname은 사용자의 전체 이름입니다. |
|
| groups는 이 사용자가 멤버인 그룹 이름을 지정합니다. 이 필드는 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 이 User의 이름이 포함된 Group 오브젝트를 만듭니다. |
|
| ID는 이 사용자와 연결된 ID입니다. |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 메타데이터는 표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
5.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/users
-
DELETE
: 사용자 컬렉션 삭제 -
GET
: 사용자 유형의 오브젝트 목록 또는 감시 -
POST
: 사용자 생성
-
/apis/user.openshift.io/v1/watch/users
-
GET
: individual changes to a list of users. deprecated: 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
/apis/user.openshift.io/v1/users/{name}
-
DELETE
: 사용자 삭제 -
GET
: 지정된 사용자 읽기 -
PATCH
: 지정된 사용자를 부분적으로 업데이트 -
PUT
: 지정된 사용자 교체
-
/apis/user.openshift.io/v1/watch/users/{name}
-
GET
: 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수를 사용하여 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
5.2.1. /apis/user.openshift.io/v1/users
- HTTP 방법
-
DELETE
- 설명
- 사용자 컬렉션 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 사용자 유형의 오브젝트 나열 또는 감시
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- 사용자 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
5.2.2. /apis/user.openshift.io/v1/watch/users
- HTTP 방법
-
GET
- 설명
- User. deprecated 목록에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
5.2.3. /apis/user.openshift.io/v1/users/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 사용자 이름 |
- HTTP 방법
-
DELETE
- 설명
- 사용자 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 사용자 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 사용자를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 사용자 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
5.2.4. /apis/user.openshift.io/v1/watch/users/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 사용자 이름 |
- HTTP 방법
-
GET
- 설명
- User. deprecated 오브젝트 변경 사항을 확인합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.