Domain #

Package : spaceone.api.identity.v2

Domain #

Domain Methods:

Method	Request	Response
create	CreateDomainRequest	DomainInfo
update	UpdateDomainRequest	DomainInfo
delete	DomainRequest	Empty
enable	DomainRequest	DomainInfo
disable	DomainRequest	DomainInfo
get	DomainRequest	DomainInfo
get_auth_info	GetDomainAuthRequest	DomainAuthInfo
get_public_key	AuthenticationRequest	AuthenticationResponse
list	DomainSearchQuery	DomainsInfo
stat	DomainStatQuery	Struct

create #

POST /identity/v2/domain/create

Request Example

CreateDomainRequest

name (string) Required
admin (Admin) Required
tags (Struct)

{
 "name": "wonny-dev",
 "admin": {
   "user_id": "wonny@cloudforet.io",
   "name": "Wonny",
   "password": "Password1234!",
   "email": "wonny@cloudforet.io",
   "language": "en",
   "timezone": "UTC"
 }
}

Response Example

DomainInfo

domain_id (string) Required
name (string) Required
state (State) Required
tags (Struct) Required
created_at (string) Required
deleted_at (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev",
 "state": "ENABLED",
 "created_at": "2024-11-12T02:24:01.233Z"
}

update #

POST /identity/v2/domain/update

Request Example

UpdateDomainRequest

domain_id (string) Required
name (string)
tags (Struct)

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev"
}

Response Example

DomainInfo

domain_id (string) Required
name (string) Required
state (State) Required
tags (Struct) Required
created_at (string) Required
deleted_at (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev",
 "state": "ENABLED",
 "created_at": "2024-11-12T02:24:01.233Z"
}

delete #

POST /identity/v2/domain/delete

Request Example

DomainRequest

domain_id (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6"
}

enable #

POST /identity/v2/domain/enable

Request Example

DomainRequest

domain_id (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6"
}

Response Example

DomainInfo

domain_id (string) Required
name (string) Required
state (State) Required
tags (Struct) Required
created_at (string) Required
deleted_at (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev",
 "state": "ENABLED",
 "created_at": "2024-11-12T02:24:01.233Z"
}

disable #

POST /identity/v2/domain/disable

Request Example

DomainRequest

domain_id (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6"
}

Response Example

DomainInfo

domain_id (string) Required
name (string) Required
state (State) Required
tags (Struct) Required
created_at (string) Required
deleted_at (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev",
 "state": "ENABLED",
 "created_at": "2024-11-12T02:24:01.233Z"
}

get #

POST /identity/v2/domain/get

Request Example

DomainRequest

domain_id (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6"
}

Response Example

DomainInfo

domain_id (string) Required
name (string) Required
state (State) Required
tags (Struct) Required
created_at (string) Required
deleted_at (string) Required

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev",
 "state": "ENABLED",
 "created_at": "2024-11-12T02:24:01.233Z"
}

get_auth_info #

+noauth

POST /identity/v2/domain/get-auth-info

Request Example

GetDomainAuthRequest

name (string) Required

{
 "name": "wonny-dev"
}

Response Example

DomainAuthInfo

domain_id (string) Required
name (string) Required
external_auth_state (ExternalAuthState) Required
metadata (Struct) Required
config (Struct) Required

{
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "wonny-dev",
 "external_auth_state": "DISABLED",
 "metadata": {},
 "config": {
     "settings": {
       "unified_cost_config": {
         "aggregation_day": 15.0,
         "currency": "KRW",
         "custom_exchange_rate": {},
         "exchange_date": 15.0,
         "exchange_rate_mode": "AUTO",
         "exchange_source": "Yahoo! Finance",
         "is_exchange_last_day": false,
         "is_last_day": false,
         "run_hour": 0.0
       }
     }
 }
}

get_public_key #

list #

POST /identity/v2/domain/list

Request Example

DomainSearchQuery

query (Query)
domain_id (string)
name (string)
state (State)

{
 "query": {
   "filter": [{
     "k": "tag.env",
     "v": "dev",
     "o": "eq"
   }],
   "sort": [{
     "key": "created_at",
     "desc": true
   }]
 }
}

Response Example

DomainsInfo

results (DomainInfo) Repeated Required
total_count (int32) Required

{
 "results": [
 {
   "domain_id": "domain-a1b2c3d4e5f6",
   "name": "wonny-dev1",
   "state": "ENABLED",
   "created_at": "2024-11-12T02:24:01.233Z"
 },
 {
   "domain_id": "domain-g7h8i9j1k2l3",
   "name": "wonny-dev2",
   "state": "ENABLED",
   "created_at": "2024-11-01T03:34:01.233Z"
 }
 ],
 "total_count": 2
}

stat #

Message #

Admin #

user_id (string) Required
name (string) Required
password (string) Required
email (string)
language (string)
timezone (string)
tags (Struct)
reset_password (bool)

CreateDomainRequest #

name (string) Required
admin (Admin) Required
tags (Struct)

DomainAuthInfo #

domain_id (string) Required
name (string) Required
external_auth_state (ExternalAuthState) Required
metadata (Struct) Required
config (Struct) Required

DomainInfo #

domain_id (string) Required
name (string) Required
state (State) Required
tags (Struct) Required
created_at (string) Required
deleted_at (string) Required

DomainRequest #

domain_id (string) Required

DomainSearchQuery #

query (Query)
domain_id (string)
name (string)
state (State)

DomainStatQuery #

query (StatisticsQuery) Required

DomainsInfo #

results (DomainInfo) Repeated Required
total_count (int32) Required

GetDomainAuthRequest #

name (string) Required

UpdateDomainRequest #

domain_id (string) Required
name (string)
tags (Struct)