Home >> Admin.get

管理者情報取得API

SMPの管理者情報を参照するためのAPIです。

メソッド名

admin.get

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/admin

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=
order	オプション	並び順の項目指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照
direction	オプション	並び順を指定する「asc」（昇順）または「desc」（降順）
limit	オプション	1回のリクエストで取得するレコード数（最大1000）
offset	オプション	レコードのオフセット

検索条件・並び順に指定可能なカラム

カラム名	検索条件	並び順	内容
Id	○	○	管理者ID
UserId	○	○	ユーザーID
LoginId	○	○	ログインID ※「制限事項」を参照
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
AdminLevelId	○	×	管理者レベル
Name1	○	○	姓
Name2	○	○	名
Name3	○	○	ミドルネーム
Name1Ka	○	○	姓フリガナ
Name2Ka	○	○	名フリガナ
CompanyName	○	○	会社名
Division	○	○	部署
Position	○	○	役職
Tel	○	○	電話番号
SubTel	○	○	電話番号予備
Fax	○	○	ファックス番号
Email	○	○	E-Mail アドレス
SubEmail	○	○	E-mailアドレス予備
Reserve1	○	○	予備1
Reserve2	○	○	予備2
Reserve3	○	○	予備3
Memo	○	○	メモ
NotificationType	○	○	通知メール(満席・残席・申込期限)
Timezone	○	○	タイムゾーン
GroupId	○	○	グループID
LanguageId	○	×	言語ID
LocalLoginId※注1	○	○	直接ログイン
SamlLoginId※注1	○	○	外部IDプロバイダ経由のログイン
SamlLoginNameId※注1	○	○	外部IDプロバイダ用ユーザ識別子

※注1 管理者シングルサインオン機能を有効にした場合のみ利用する項目
（管理者シングルサインオン機能を有効にしない場合も検索・ソートは可能）なお、SamlLoginNameId は、ソート順が昇順の場合最後に、降順の場合は最初に出力されます。

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：AdminData ★ データ型：AdminDataType

カラム名	データ型	内容
Id	string	管理者ID
UserId	string	ユーザーID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時（JST） YYYY-mm-ddTHH:MM:SS+09:00
AdminLevelId	AdminLevelType	管理者レベル AdminLevelId：AdminLevelName
LoginId	string	ログインID
LoginPassword	string	ログインパスワード ※SMPでシステム設定「パスワードを暗号化して保存」が「有効」の場合は出力されません。
Name1	string	姓
Name2	string	名
Name3	string	ミドルネーム
Name1Ka	string	姓フリガナ
Name2Ka	string	名フリガナ
CompanyName	string	会社名
Division	string	部署
Position	string	役職
Tel	string	電話番号
SubTel	string	電話番号予備
Fax	string	ファックス番号
Email	string	E-Mail アドレス
SubEmail	string	E-mailアドレス予備
Reserve1	string	予備1
Reserve2	string	予備2
Reserve3	string	予備3
Memo	string	メモ
Language	LanguageType	使用言語 LanguageId：LanguageName 1：日本語 2：英語
NotificationType	NotificationTypeType	NotificationTypedId：NotificationTypeName 1：配信しない 2：担当キャンペーンのみ配信する 3：全て配信する
Timezone	TimezoneType	タイムゾーンIDとタイムゾーン名の対応表参照
Group	GroupType	グループ GroupId：GroupName グループID：グループ名
LocalLogin	LocalLoginType	※注2 直接ログイン LocalLoginId：LocalLoginName 直接ログインID：直接ログイン名 0 許可しない 1 許可する
SamlLogin	SamlLoginType	※注2 外部IDプロバイダ経由のログイン SamlLoginId：SamlLoginName 外部IDプロバイダ経由のログインID：外部IDプロバイダ経由のログイン名 0 許可しない 1 許可する
SamlLoginNameId	String	※注2 外部IDプロバイダ用ユーザ識別子

※注2 管理者シングルサインオン機能を有効にした場合のみ利用する項目
（管理者シングルサインオン機能を有効にしない場合も出力します）

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<AdminDataList xmlns="http://smartseminar.jp/" version="1.56">
  <AdminData>
    <NotificationType>
      <NotificationTypeName>担当キャンペーンのみ配信する</NotificationTypeName>
      <NotificationTypeId>2</NotificationTypeId>
    </NotificationType>
    <Division>管理者部署</Division>
    <UserId>21</UserId>
    <SubTel>090-1234-5678</SubTel>
    <Memo>管理者メモ</Memo>
    <DateRegist>2018-07-10T21:16:20+09:00</DateRegist>
    <Email>test.ss.a1.aws001+804admin@st-bounce.shanon.co.jp</Email>
    <Position>管理者役職</Position>
    <Group>
      <GroupId>2</GroupId>
      <GroupName>キャンペーン管理者</GroupName>
    </Group>
    <DateUpdate>2018-07-11T10:59:42+09:00</DateUpdate>
    <SamlLogin>
      <SamlLoginName>許可しない</SamlLoginName>
      <SamlLoginId>0</SamlLoginId>
    </SamlLogin>
    <Name1>管理者姓</Name1>
    <CompanyName>管理者会社名</CompanyName>
    <LocalLogin>
      <LocalLoginName>許可する</LocalLoginName>
      <LocalLoginId>1</LocalLoginId>
    </LocalLogin>
    <Name2Ka>カンリシャメイ</Name2Ka>
    <Timezone>
      <TimezoneName>(GMT+09:00) 日本標準時 - 東京</TimezoneName>
      <TimezoneId>Asia/Tokyo</TimezoneId>
    </Timezone>
    <Reserve1>予備1</Reserve1>
    <AdminLevel>
      <AdminLevelName>特権管理者</AdminLevelName>
      <AdminLevelId>2</AdminLevelId>
    </AdminLevel>
    <Name2>管理者名</Name2>
    <SamlLoginNameId>saml_id_0001</SamlLoginNameId>
    <SubEmail>test.ss.a2.aws001+804admin@st-bounce.shanon.co.jp</SubEmail>
    <Id>12</Id>
    <Name3>管理者ミドルネーム</Name3>
    <Language>
      <LanguageName>日本語</LanguageName>
      <LanguageId>1</LanguageId>
    </Language>
    <Reserve3>予備3</Reserve3>
    <Name1Ka>カンリシャセイ</Name1Ka>
    <LoginPassword>5TtGbwM7</LoginPassword>
    <Tel>03-1234-5678</Tel>
    <Reserve2>予備2</Reserve2>
    <LoginId>special_admin10</LoginId>
    <Fax>03-2345-6789</Fax>
  </AdminData>
</AdminDataList>

制限事項

LoginIDによる検索は、認証ログインキーの設定に関わらず大文字/小文字を区別した検索になります。
「外部IDプロバイダ用ユーザ識別子（SamlLoginNameId）」「ne」「何らかの文字列」とした場合、「外部IDプロバイダ用ユーザ識別子」が空値のものは抽出対象外となります。